Endpoint
POST https://api.tiny.com.br/api2/tag.pesquisa.php
Parâmetros
| Parâmetro | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| token | string | obrigatório | Chave gerada para identificar sua empresa |
| formato | string | obrigatório | Formato do retorno (json) |
| pesquisa | string | opcional | Nome ou parte do nome do grupo de tags |
| idGrupo | int | opcional | Número de identificação do grupo |
| pagina | int | opcional | Número da página (padrão: 1, 100 registros/página) |
Ao menospesquisaouidGrupodeve ser informado.
Retorno
| Campo | Tipo | Tamanho | Ocorrência | Descrição |
|---|---|---|---|---|
| retorno.status_processamento | int | - | obrigatório | Status do processamento |
| retorno.status | string | - | obrigatório | ”OK” ou “Erro” |
| retorno.codigo_erro | int | - | condicional | Código do erro |
| retorno.pagina | int | - | obrigatório | Número da página retornada |
| retorno.numero_paginas | int | - | obrigatório | Total de páginas |
| retorno.registros[].registro.id | int | - | condicional | Identificação da tag |
| retorno.registros[].registro.nome | string | 50 | condicional | Nome da tag |
| retorno.registros[].registro.id_grupo | int | - | condicional | ID do grupo |
| retorno.registros[].registro.grupo | string | - | condicional | Nome do grupo |
Exemplo de chamada
$url = 'https://api.tiny.com.br/api2/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": "OK",
"pagina": "1",
"registros": [
{
"registro": {
"id": "46829060",
"nome": "nova",
"id_grupo": "46829059",
"grupo": "Teste de Grupo 3"
}
}
]
}
}
Erro
{
"retorno": {
"status": "Erro",
"codigo_erro": 2,
"erros": [{"erro": "token invalido"}]
}
}