Endpoint
POST https://api.tiny.com.br/api2/tag.incluir.php
Parâmetros
| Parâmetro | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| token | string | obrigatório | Chave gerada para identificar sua empresa |
| tag | object | obrigatório | Dados da tag conforme layout especificado |
| formato | string | obrigatório | Formato do retorno (json) |
Estrutura do parâmetro “tag”
| Campo | Tipo | Tamanho | Ocorrência | Descrição |
|---|---|---|---|---|
| tags[] | list | - | obrigatório | Lista de tags |
| tags[].tag.sequencia | inteiro | - | obrigatório | Número sequencial |
| tags[].tag.nome | string | 50 | obrigatório | Nome da tag |
| tags[].tag.id_grupo | inteiro | - | obrigatório | Identificação do grupo de tag |
Retorno
| Campo | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| retorno.status_processamento | int | obrigatório | Status processual |
| retorno.status | string | obrigatório | ”OK” ou “Erro” |
| retorno.codigo_erro | int | condicional | Conforme tabela de códigos |
| retorno.registros[].registro.sequencia | int | condicional | Número sequencial |
| retorno.registros[].registro.status | string | condicional | ”OK” ou “Erro” |
| retorno.registros[].registro.id | int | condicional | ID da tag criada |
Exemplo de chamada
$url = 'https://api.tiny.com.br/api2/tag.incluir.php';
$token = 'sua_chave_api';
$data = "token=$token&tag={...}&formato=JSON";
enviarREST($url, $data);
Exemplos de retorno
Sucesso
{
"retorno": {
"status_processamento": 3,
"status": "OK",
"registros": [
{
"registro": {
"sequencia": "1",
"status": "OK",
"id": "37644487"
}
}
]
}
}
Erro
{
"retorno": {
"status_processamento": 1,
"status": "Erro",
"codigo_erro": 2,
"erros": [{"erro": "token invalido"}]
}
}