Pesquisar Vendedores API 2.0
Serviço destinado a fazer consulta de vendedores.
Parâmetros do serviço
Elemento | Tipo | Ocorrência | Descrição |
---|---|---|---|
token | string | obrigatório | Chave gerada para identificar sua empresa |
pesquisa | string | obrigatório | Nome ou código (ou parte) do vendedor que deseja consultar |
formato | string | obrigatório | Formato do retorno (json ou xml) |
pagina (1) | int | opcional | Número da página |
(1) - Número da página de vendedores que deseja obter (por padrão são listados 100 registros por página), caso não seja informado o valor padrão é 1.
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) (3) | list | - | condicional [0..n] | Contém a lista dos erros encontrados. |
retorno.erros[ ].erro | string | - | condicional | Mensagem contendo a descrição do erro |
retorno.pagina | int | - | obrigatório | Número da página que está sendo retornada |
retorno.numero_paginas | int | - | obrigatório | Número de paginas do retorno |
retorno.vendedores[ ] (2) | list | - | condicional | Lista de resultados da pesquisa |
retorno.vendedores[ ].vendedor (2) | object | - | condicional | Elemento utilizado para representar um vendedor. |
retorno.vendedores[ ].vendedor.id | int | - | condicional | Número de identificação do vendedor no Tiny |
retorno.vendedores[ ].vendedor.codigo | string | 30 | condicional | Código do vendedor |
retorno.vendedores[ ].vendedor.nome | string | 50 | condicional | Nome ou razão social do contato |
retorno.vendedores[ ].vendedor.fantasia | string | 30 | condicional | Nome fatansia do vendedor |
retorno.vendedores[ ].vendedor.tipo_pessoa | string | 1 | condicional | Tipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro) |
retorno.vendedores[ ].vendedor.cpf_cnpj | string | 18 | condicional | CPF ou CNPJ do vendedor |
retorno.vendedores[ ].vendedor.email | string | 50 | condicional | Endereço de e-mail do vendedor |
retorno.vendedores[ ].vendedor.endereco | string | 50 | condicional | Endereço do vendedor |
retorno.vendedores[ ].vendedor.numero | string | 10 | condicional | Número do endereço do vendedor |
retorno.vendedores[ ].vendedor.complemento | string | 50 | condicional | Complemento do endereço do vendedor |
retorno.vendedores[ ].vendedor.bairro | string | 30 | condicional | Bairro do vendedor |
retorno.vendedores[ ].vendedor.cep | string | 10 | condicional | Cep do vendedor |
retorno.vendedores[ ].vendedor.cidade | string | 30 | condicional | Nome da cidade conforme a Tabela de Cidades |
retorno.vendedores[ ].vendedor.uf | string | 30 | condicional | UF do vendedor |
retorno.vendedores[ ].vendedor.situacao | string | 15 | condicional | Situação do vendedor (Ativo,Excluido) |
(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) - Estes campos somente serão informados caso o retorno contenha erros.
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/vendedores.pesquisa.php';
$token = 'coloque aqui a sua chave da api';
$pesquisa = 'xxxxx';
$formato = 'XML';
$data = "token=$token&pesquisa=$pesquisa&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;
}
$client = new nusoap_client("https://api.tiny.com.br/api2.php?wsdl", true);
$client->soap_defencoding = 'UTF-8';
$client->decode_utf8 = false;
$result = $client->call("pesquisarVendedoresService", array('token' => 'xxxxx','pesquisa'=>'xxxxx','formato'=>'XML'));
$res = array();
if ($client->fault) {
$retorno = $result['faultstring'];
} else {
$err = $client->getError();
if ($err) {
$retorno = $err;
} else {
$retorno = $result;
}
}
Exemplos de retorno da API
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
<status_processamento>1</status_processamento>
<status>Erro</status>
<codigo_erro>2</codigo_erro>
<erros>
<erro>token invalido</erro>
</erros>
</retorno>
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
<status_processamento>2</status_processamento>
<status>Erro</status>
<codigo_erro>21</codigo_erro>
<erros>
<erro>A consulta retornou mais registros que o permitido</erro>
</erros>
</retorno>
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
<status_processamento>3</status_processamento>
<status>OK</status>
<pagina>1</pagina>
<numero_paginas>1</numero_paginas>
<vendedores>
<vendedor>
<id>46829055</id>
<codigo>123</codigo>
<nome>Vendedor Teste</nome>
<fantasia>Teste</fantasia>
<tipo_pessoa>F</tipo_pessoa>
<cpf_cnpj>00000000000</cpf_cnpj>
<email>vendedor_teste@mail.com</email>
<endereco>Rua Teste</endereco>
<numero>123</numero>
<complemento>sala 1</complemento>
<bairro>Centro</bairro>
<cep>95700-000</cep>
<uf>RS</uf>
<situacao>Ativo</situacao>
</vendedor>
</vendedores>
</retorno>