Obter Contato API 2.0
Serviço destinado a fazer consulta de Contato.
Parâmetros do serviço
Elemento | Tipo | Ocorrência | Descrição |
---|---|---|---|
token | string | obrigatório | Chave gerada para identificar sua empresa |
id | int | obrigatório | Número de identificação do contato no Tiny |
formato | string | obrigatório | Formato do retorno (json) |
Retorno do serviço
Elemento | Tipo | Tamanho | Ocorrência | Descrição |
---|---|---|---|---|
retorno | object | - | obrigatório | Elemento raiz do retorno |
retorno.status_processamento | int | - | obrigatório | Conforme tabela "Status de Processamento" |
retorno.status | string | - | obrigatório | Contém o status do retorno “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo |
retorno.codigo_erro (1) | int | - | condicional | Conforme tabela "Códigos de erro" |
retorno.erros[ ] (1) (7) | list | - | condicional [0..n] | Contém a lista dos erros encontrados. |
retorno.erros[ ].erro | string | - | condicional | Mensagem contendo a descrição do erro |
retorno.contato (2) | object | - | condicional | Elemento utilizado para representar um contato. |
retorno.contato.id | int | - | condicional | Número de identificação do contato no Tiny |
retorno.contato.codigo | string | 30 | condicional | Código do contato |
retorno.contato.nome | string | 50 | condicional | Nome ou razão social do contato |
retorno.contato.fantasia | string | 60 | condicional | Nome fatansia do contato |
retorno.contato.tipo_pessoa | string | 1 | condicional | Tipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro) |
retorno.contato.cpf_cnpj | string | 18 | condicional | CPF ou CNPJ do contato |
retorno.contato.ie | string | 18 | condicional | Inscrição estadual do contato |
retorno.contato.rg | string | 10 | condicional | RG do contato |
retorno.contato.im | string | 18 | condicional | Inscrição municipal do contato |
retorno.contato.endereco | string | 50 | condicional | Endereço do contato |
retorno.contato.numero | string | 10 | condicional | Número do endereço do contato |
retorno.contato.complemento | string | 50 | condicional | Complemento do endereço do contato |
retorno.contato.bairro | string | 30 | condicional | Bairro do contato |
retorno.contato.cep | string | 10 | condicional | Cep do contato |
retorno.contato.cidade | string | 30 | condicional | Nome da cidade conforme a Tabela de Cidades |
retorno.contato.uf | string | 30 | condicional | UF do contato |
retorno.contato.pais | string | 50 | condicional | Nome do País conforme Tabela de Países |
retorno.contato.endereco_cobranca (3) | string | 50 | condicional | Endereço de cobrança do contato |
retorno.contato.numero_cobranca (3) | string | 10 | condicional | Número do endereço de cobrança do contato |
retorno.contato.complemento_cobranca (3) | string | 50 | condicional | Complemento do endereço de cobrança do contato |
retorno.contato.bairro_cobranca (3) | string | 30 | condicional | Bairro de cobrança do contato |
retorno.contato.cep_cobranca (3) | string | 10 | condicional | Cep de cobrança do contato |
retorno.contato.cidade_cobranca (3) | string | 30 | condicional | Nome da cidade de cobrança conforme a Tabela de Cidades |
retorno.contato.uf_cobranca (3) | string | 30 | condicional | UF de cobrança do contato |
retorno.contato.contatos | string | 100 | condicional | Pessoas de Contato |
retorno.contato.fone | string | 40 | condicional | Telefone do Contato |
retorno.contato.fax | string | 40 | condicional | Fax do Contato |
retorno.contato.celular | string | 40 | condicional | Telefone Celular do Contato |
retorno.contato.email | string | 50 | condicional | Email do Contato |
retorno.contato.email_nfe | string | 50 | condicional | Email para envio de nfe do Contato |
retorno.contato.site | string | 40 | condicional | Site do Contato |
retorno.contato.crt | string | 1 | condicional | Código de regime tributário |
retorno.contato.estadoCivil (4) | int | - | condicional | Código conforme Tabela Estado Civil |
retorno.contato.profissao (4) | string | 50 | condicional | Profissão do Contato |
retorno.contato.sexo (4) | string | 10 | condicional | Sexo do Contato - ("masculino","feminino") |
retorno.contato.data_nascimento (4) (5) | string | 10 | condicional | Data de nascimento do contato |
retorno.contato.naturalidade (4) | string | 40 | condicional | Naturalidade do contato |
retorno.contato.nome_pai (4) | string | 100 | condicional | Nome do pai do contato |
retorno.contato.cpf_pai (4) | string | 18 | condicional | CPF do pai do contato |
retorno.contato.nome_mae (4) | string | 100 | condicional | Nome da mãe do contato |
retorno.contato.cpf_mae (4) | string | 18 | condicional | CPF da mãe do contato |
retorno.contato.limite_credito (6) | decimal | - | condicional | Limite de crédito docontato |
retorno.contato.situacao | string | 1 | condicional | Situação do Contato ("A" - Ativo, "E" - Excluido, "I" - Inativo,"S" - Sem Movimento) |
retorno.contato.obs | string | 200 | condicional | Observações gerais sobre o contato. |
retorno.contato.id_lista_preco | int | - | condicional | Número de identificação da lista de preços no Tiny |
retorno.contato.id_vendedor | int | - | condicional | Número de identificação do Vendedor associado ao contato. |
retorno.contato.nome_vendedor | string | 50 | condicional | Nome do Vendedor associado ao contato. |
retorno.contato.data_criacao | string | 19 | condicional | Data de criação do contato. Formato dd/mm/aaaa hh:mm:ss |
retorno.contato.data_atualizacao | string | 19 | obrigatório | Data da última atualização do contato. Formato dd/mm/aaaa hh:mm:ss |
retorno.contato.tipos_contato[] | list | - | condicional | Lista de tipos do contato |
retorno.contato.tipos_contato[].tipo | string | 30 | condicional | Descrição do tipo do contato, conforme a tabela de tipos de contatos na sua conta Tiny |
retorno.contato.pessoas_contato[] | list | - | condicional | Lista de pessoas de contato |
retorno.contato.pessoas_contato[].pessoa_contato | object | - | condicional | Elemento utilizado para representar uma pessoa de contato |
retorno.contato.pessoas_contato[].pessoa_contato.id_pessoa | int | - | condicional | Número de identificação da pessoa de contato no Tiny |
retorno.contato.pessoas_contato[].pessoa_contato.nome | string | 50 | condicional | Nome da pessoa de contato |
retorno.contato.pessoas_contato[].pessoa_contato.telefone | string | 30 | condicional | Telefone da pessoa de contato |
retorno.contato.pessoas_contato[].pessoa_contato.ramal | string | 20 | condicional | Ramal da pessoa de contato |
retorno.contato.pessoas_contato[].pessoa_contato.email | string | 50 | condicional | e-mail da pessoa de contato |
retorno.contato.pessoas_contato[].pessoa_contato.departamento | string | 50 | condicional | Departamento da pessoa de contato |
(1) - Somente estará presente no retorno caso o elemento "status" seja "Erro".
(2) - Somente estará presente no retorno caso o elemento "status" seja "OK".
(3) - O endereço de cobrança é opcional, deve ser informado somente caso ele seja diferente do endereço do contato.
(4) - Estes campos são opcionais, e devem ser informados somente se o contato seja pessoa física.
(5) - Estes campos devem ser informados no formato dd/mm/yyyy, exemplo "01/01/2012".
(6) - Estes campos utilizam “.” (ponto) como separador de decimais, exemplo "5.25".
(7) - Estes campos somente serão informados caso o retorno contenha erros.
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/contato.obter.php';
$token = 'coloque aqui a sua chave da api';
$id = 'xxxxx';
$formato = 'JSON';
$data = "token=$token&id=$id&formato=$formato";
enviarREST($url, $data);
function enviarREST($url, $data, $optional_headers = null) {
$params = array('http' => array(
'method' => 'POST',
'content' => $data
));
if ($optional_headers !== null) {
$params['http']['header'] = $optional_headers;
}
$ctx = stream_context_create($params);
$fp = @fopen($url, 'rb', false, $ctx);
if (!$fp) {
throw new Exception("Problema com $url, $php_errormsg");
}
$response = @stream_get_contents($fp);
if ($response === false) {
throw new Exception("Problema obtendo retorno de $url, $php_errormsg");
}
return $response;
}