Endpoint
POST https://api.tiny.com.br/api2/grupo.tag.pesquisa.php
Parâmetros
| Parâmetro | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| token | string | obrigatório | Chave gerada para identificar sua empresa |
| pesquisa | string | obrigatório | Nome ou parte do nome do grupo de tags que deseja consultar |
| formato | string | obrigatório | Formato do retorno (json) |
| pagina | int | opcional | Número da página (padrão: 1, lista 100 registros por página) |
Retorno
| Campo | Tipo | Tamanho | Ocorrência | Descrição |
|---|---|---|---|---|
| retorno | object | - | obrigatório | Nodo raiz do retorno |
| retorno.status_processamento | int | - | obrigatório | Conforme tabela “Status de Processamento” |
| retorno.status | string | - | obrigatório | ”OK” ou “Erro” |
| retorno.codigo_erro | int | - | condicional | Conforme tabela “Códigos de erro” |
| retorno.erros[] | list | - | condicional | Lista dos erros encontrados |
| retorno.erros[].erro | string | - | condicional | Mensagem com descrição do erro |
| retorno.pagina | int | - | obrigatório | Número da página retornada |
| retorno.numero_paginas | int | - | obrigatório | Número de páginas do retorno |
| retorno.registros[] | list | - | condicional | Lista de resultados da pesquisa |
| retorno.registros[].registro | object | - | condicional | Elemento representando um Grupo de Tag |
| retorno.registros[].registro.id | int | - | condicional | Identificação do Grupo de Tag na Olist |
| retorno.registros[].registro.nome | string | 50 | condicional | Nome do Grupo de Tag |
Exemplo de chamada
$url = 'https://api.tiny.com.br/api2/grupo.tag.pesquisa.php';
$token = 'sua_chave_api';
$pesquisa = 'xxxxx';
$data = "token=$token&pesquisa=$pesquisa&formato=JSON";
enviarREST($url, $data);
Exemplos de retorno
Sucesso
{
"retorno": {
"status_processamento": 3,
"status": "OK",
"pagina": "1",
"numero_paginas": "1",
"registros": [
{
"registro": {
"id": "37644487",
"nome": "Grupo Teste 2"
}
},
{
"registro": {
"id": "37644488",
"nome": "Grupo Teste 3"
}
}
]
}
}
Erro - Token inválido
{
"retorno": {
"status_processamento": 1,
"status": "Erro",
"codigo_erro": 2,
"erros": [
{
"erro": "token invalido"
}
]
}
}
Erro - Sem registros
{
"retorno": {
"status_processamento": 2,
"status": "Erro",
"codigo_erro": 20,
"erros": [
{
"erro": "A Consulta não retornou registros"
}
]
}
}