Obter Estrutura do Produto API 2.0

Serviço destinado a obter a estrutura do Produto.

Parâmetros do serviço

ElementoTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
idintobrigatórioNúmero de identificação do produto no Tiny
formatostringobrigatórioFormato do retorno (json ou xml)

Retorno do serviço

ElementoTipoTamanhoOcorrênciaDescrição
retorno object-obrigatórioElemento raiz do retorno
retorno.status_processamentoint-obrigatórioConforme tabela "Status de Processamento"
retorno.statusstring-obrigatórioContém o status do retorno “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo
retorno.codigo_erro (1)int-condicionalConforme tabela "Códigos de erro"
retorno.erros[ ] (1) (3)list-condicional [0..n]Contém a lista dos erros encontrados.
retorno.erros[ ].errostring-condicionalMensagem contendo a descrição do erro
retorno.produto (2)object-condicionalElemento utilizado para representar um produto.
retorno.produto.idint-condicionalNúmero de identificação do produto no Tiny
retorno.produto.nomestring120condicionalNome do produto
retorno.produto.codigostring30condicionalCódigo do produto
retorno.produto.estrutura[ ]list-condicionalLista de componentes do produto
retorno.produto.estrutura[ ].itemobject- condicionalitem da composição do produto
retorno.produto.estrutura[ ].item.id_componenteint-condicionalNúmero de identificação do componente (produto) no Tiny
retorno.produto.estrutura[ ].item.codigostring30condicionalCódigo do componente
retorno.produto.estrutura[ ].item.nomestring120condicionalNome do componente
retorno.produto.estrutura[ ].item.quantidade (4)decimal-condicionalQuantidade do item na composição

(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 “.” (ponto) como separador de decimais, exemplo "5.25".

Exemplos de chamada da API

Exemplos da chamada em REST 


$url = 'https://SERVER_API_DIRapi2/produto.obter.estrutura.php';
$token = 'coloque aqui a sua chave da api';
$id = 'xxxxx';
$formato = 'XML';
$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;
}

Exemplos da chamada em SOAP 


$client = new nusoap_client("https://SERVER_API_DIRapi2.php?wsdl", true);
$client->soap_defencoding = 'UTF-8';
$client->decode_utf8 = false;

$result = $client->call("obterEstruturaProdutoService", array('token' => 'xxxxx','id'=>'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

Exemplos do retorno do serviço em JSON

Exemplos do retorno do serviço em XML 

<?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>32</codigo_erro>
  <erros>
    <erro>Produto não localizado</erro>
  </erros>
</retorno>

<?xml version="1.0" encoding="UTF-8"?>
<retorno>
  <status_processamento>3</status_processamento>
  <status>OK</status>
  <produto>
    <id>16492053</id>
    <nome>kit teste</nome>
    <codigo>12345</codigo>
    <estrutura>
      <item>
        <id_componente>626414</id_componente>
        <codigo>1</codigo>
        <nome>Caderno</nome>
        <id_tag>6301492</id_tag>
        <nome_tag>caderno</nome_tag>
        <quantidade>1.0000</quantidade>
      </item>
      <item>
        <id_componente>11086140</id_componente>
        <codigo>223435780</codigo>
        <nome>Caneta 001</nome>
        <id_tag>7399555</id_tag>
        <nome_tag>Azul</nome_tag>
        <quantidade>2.0000</quantidade>
      </item>
    </estrutura>
  </produto>
</retorno>