Incluir Tag API 2.0
Serviço destinado a fazer inclusão de Tags.
Parâmetros do serviço
| Elemento | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| token | string | obrigatório | Chave gerada para identificar sua empresa |
| tag (1) | - | obrigatório | Dados da tag conforme layout |
| formato | string | obrigatório | Formato do retorno (json) |
| Elemento | Tipo | Tamanho | Ocorrência | Descrição |
|---|---|---|---|---|
| tags[ ] | list | - | obrigatório | Elemento raiz utilizado para representar um conjunto Tags. |
| tags[ ].tag | object | - | obrigatório | Elemento utilizado para representar uma Tag. |
| tags[ ].tag.sequencia | inteiro | - | obrigatório | Número sequencial utilizado para identificar cada tag. |
| tags[ ].tag.nome | string | 50 | obrigatório | Nome da Tag. |
| tags[ ].tag.id_grupo | inteiro | - | obrigatório | Número de indentificação da Grupo de Tag no Tiny. |
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 | - | obrigatório | 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.registros (2) | list | - | condicional | Lista de resultados da inclusão |
| retorno.registros[ ].registro (2) | object | - | condicional | Elemento utilizado para representar uma Tag. |
| retorno.registros[ ].registro.sequencia | int | - | condicional | Número sequencial utilizado para identificar cada tag. |
| retorno.registros[ ].registro.status | string | - | condicional | Contém o status do registro “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo |
| retorno.registros[ ].registro.codigo_erro | int | - | condicional | Conforme tabela "Códigos de erro" |
| retorno.registros[ ].registro.erros[ ] (3) | list | - | condicional [0..n] | Contém a lista dos erros encontrados. |
| retorno.registros[ ].registro.erros[ ].erro | string | - | condicional | Mensagem contendo a descrição do erro |
| retorno.registros[ ].registro.id | int | - | condicional | Número de identificação da Tag no Tiny |
(1) - Somente estará presente no retorno caso o elemento "status" seja "Erro".
(2) - Somente estará presente no retorno caso o elemento "status" seja diferente de "OK".
(3) - Estes campos somente serão informados caso o retorno contenha erros.
Exemplos do parâmetro tag
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/tag.incluir.php';
$token = 'coloque aqui a sua chave da api';
$tag = '{...}';
$data = "token=$token&tag=$tag&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;
}
