A API V3 JÁ ESTÁ DISPONÍVEL
As integrações API v2 que já estão configuradas, seguirão funcionando temporariamente. |
Busca um contato
Busca um contato a partir do seu identificador
.
curl |
curl -X GET "https://bling.com.br/Api/v2/contato/{cpf_cnpj}/json/" |
PHP |
$apikey = "{apikey}"; |
C# |
public static void ExecuteGetContact() { var request = HttpWebRequest.Create(@"https://bling.com.br/Api/v2/contato/{cpf_cnpj}/json&apikey={apikey}"); request.ContentType = "application/json"; request.Method = "GET"; using (HttpWebResponse response = request.GetResponse() as HttpWebResponse) { if (response.StatusCode != HttpStatusCode.OK) Console.Out.WriteLine("Error. Server returned status code: {0}", response.StatusCode); using (StreamReader reader = new StreamReader(response.GetResponseStream())) { var content = reader.ReadToEnd(); if(string.IsNullOrWhiteSpace(content)) Console.Out.WriteLine("Empty Response"); else Console.Out.WriteLine("Response Body: \r\n {0}", content); } } } |
Parâmetro | Descrição | Tipo |
apikey |
apikey gerada no sistema | string |
identificador |
Parâmetro opcional. Tipo de identificador utilizado na busca, conforme tabela de identificadores | string |
Tabela de identificadores
Valor | Identificador | Tipo |
1 |
CPF ou CNPJ (Default) | integer |
2 |
ID | integer |
Observações
- Caso o parâmetro "identificador" não seja enviado, por padrão a busca será realizada pelo CPF ou CNPJ.
- Quando a busca for pelo CPF ou CNPJ, o identificador deve ser informado no final da url.
Exemplo: https://bling.com.br/Api/v2/contato/{cpf_ou_cnpj}/json?apikey={numero-da-apikey}&identificador=1 - Quando a busca for pelo ID, o identificador (2) deve ser informado no final da url.
Exemplo: https://bling.com.br/Api/v2/contato/{ID}/json?apikey={numero-da-apikey}&identificador=2
Retorno
Em caso de sucesso, retornará o contato solicitado, no mesmo modelo do exemplo a seguir. Caso contrário, retornará um erro.
A resposta será no formato especificado na URL (XML ou JSON).
Os campos informacoesContato e pessoasContato são retornados apenas no método singular (GET/contato).
Exemplo de retorno
{ "retorno": { "contatos": [ { "contato": { "id": "2147543640", "nome": "CHEWBACCA", "fantasia": "", "tipo": "F", "cnpj": "141.286.885-84", "ie_rg": "", "endereco": "RUA TESTE", "numero": "222", "bairro": "SAN ROCCO", "cep": "95708630", "cidade": "BENTO GONÇALVES", "complemento": "", "uf": "RS", "fone": "(54) 3235-4545", "email": "starwars@organisys.com.br", "limiteCredito": "0.00", "situacao": "A", "contribuinte": "9", "nomeVendedor": "LUKE SKYWALKER", "dataNascimento": "1987-05-04", "tiposContato": [ { "tipoContato": { "descricao": "Cliente" } } ], "informacoesContato": "HAN SOLO", "pessoasContato": [ { "id": "2147536765", "nome": "DARTH VADER" } ] } } ] } }