Obter informações da conta API 2.0
Serviço destinado a obter informações da conta
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 ou xml) |
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.conta (2) | object | - | condicional | Elemento utilizado para representar a conta. |
retorno.conta.razao_social | string | 80 | condicional | Razão social da conta |
retorno.conta.cnpj_cpf | string | 20 | condicional | CNPJ/CPF da conta |
retorno.conta.fantasia | string | 80 | condicional | Nome fantasia da conta |
retorno.conta.endereco | string | 60 | condicional | Endereço da conta |
retorno.conta.numero | string | 5 | condicional | Número do endereço da conta |
retorno.conta.bairro | string | 30 | condicional | Bairro da conta |
retorno.conta.complemento | string | 20 | condicional | Complemento da conta |
retorno.conta.cidade | string | 30 | condicional | Cidade da conta |
retorno.conta.estado | string | 2 | condicional | Estado da conta |
retorno.conta.cep | string | 10 | condicional | Cep da conta |
retorno.conta.fone | string | 40 | condicional | Telefone da conta |
retorno.conta.email | string | 50 | condicional | E-mail da conta |
retorno.conta.inscricao_estadual | string | 18 | condicional | Inscrição estadual da conta |
retorno.conta.regime_tributario | string | 56 | condicional | Regime tributário da conta conforme tabela de "Regimes tributários" |
(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/info.php';
$token = 'coloque aqui a sua chave da api';
$formato = 'XML';
$data = "token=$token&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;
}
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>
<conta>
<razao_social>Empresa Ltda</razao_social>
<cnpj_cpf>00.000.000/0001-00</cnpj_cpf>
<fantasia>Empresa</fantasia>
<endereco>Rua X</endereco>
<numero>18</numero>
<bairro>Centro</bairro>
<complemento>Bloco A</complemento>
<cidade>Bento Gonçalves</cidade>
<estado>RS</estado>
<cep>95.700-000</cep>
<fone>(54) 99999-9999</fone>
<email>tiny@tiny.com.br</email>
<inscricao_estadual>0000000-00</inscricao_estadual>
<regime_tributario>Simples Nacional</regime_tributario>
</conta>
</retorno>