Pesquisar Contratos API 2.0
Serviço destinado a fazer consulta de Contratos.
Parâmetros do serviço
Elemento | Tipo | Ocorrência | Descrição |
---|---|---|---|
token | string | obrigatório | Chave gerada para identificar sua empresa |
formato | string | obrigatório | Formato do retorno (json) |
cliente (1) | string | opcional | Nome ou código (ou parte) do cliente |
cpf_cnpj (1) | string | opcional | CPF ou CNPJ do cliente |
dataInicial (1) | string | opcional | Data incial dos contratos que deseja consultar no formato dd/mm/yyyy |
dataFinal (1) | string | opcional | Data final dos contratos que deseja consultar no formato dd/mm/yyyy |
situacao (1) (2) | string | opcional | Exibir contratos na situação |
idVendedor (3) | int | opcional | Número de identificação do vendedor no Tiny |
nomeVendedor (3) (4) | string | opcional | Nome do vendedor no Tiny |
pagina (5) | int | opcional | Número da página |
(1) - Ao menos um desses parâmetros deve ser informado.
(2) - Código da situação, conforme tabela de Situações dos Contratos.
(3) - Caso o vendedor não seja localizado no Tiny a consulta não retornará registros.
(4) - Este valor será desconsiderado caso seja informado valor para o parâmetro idVendedor.
(5) - Numero da página 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.contratos[ ] (2) | list | - | condicional | Lista de resultados da pesquisa |
retorno.contratos[ ].contrato (2) | object | - | condicional | Elemento utilizado para representar um contrato |
retorno.contratos[ ].id | int | - | obrigatório | Número de identificação do contrato no Tiny |
retorno.contratos[ ].data (4) | date | 10 | obrigatório | Data do contrato |
retorno.contratos[ ].descricao | string | 50 | obrigatório | Descrição do contrato |
retorno.contratos[ ].nome | string | 50 | obrigatório | Nome do cliente |
retorno.contratos[ ].valor (5) | decimal | - | obrigatório | Valor total do contrato |
retorno.contratos[ ].id_vendedor | int | 15 | condicional | Número de identificação do vendedor associado ao contrato |
retorno.contratos[ ].nome_vendedor | string | 50 | condicional | Nome do vendedor associado ao contrato |
retorno.contratos[ ].situacao | int | - | obrigatório | Código conforme tabela de Situações dos Contratos |
retorno.contratos[ ].descricao_situacao | string | 25 | obrigatório | Descrição conforme tabela de Situações dos Contratos |
(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.
(4) - Estes campos utilizam o formato dd/mm/yyyy, exemplo "01/01/2012".
(5) - Estes campos utilizam “.” (ponto) como separador de decimais, exemplo "5.25".
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/contratos.pesquisa.php';
$token = 'coloque aqui a sua chave da api';
$numero = 'xxxxx';
$data = "token=$token&numero=$numero&formato=JSON";
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;
}