Skip to main content

Endpoint

POST https://api.tiny.com.br/api2/tag.pesquisa.php

Parâmetros

ParâmetroTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
formatostringobrigatórioFormato do retorno (json)
pesquisastringopcionalNome ou parte do nome do grupo de tags
idGrupointopcionalNúmero de identificação do grupo
paginaintopcionalNúmero da página (padrão: 1, 100 registros/página)
Ao menos pesquisa ou idGrupo deve ser informado.

Retorno

CampoTipoTamanhoOcorrênciaDescrição
retorno.status_processamentoint-obrigatórioStatus do processamento
retorno.statusstring-obrigatório”OK” ou “Erro”
retorno.codigo_erroint-condicionalCódigo do erro
retorno.paginaint-obrigatórioNúmero da página retornada
retorno.numero_paginasint-obrigatórioTotal de páginas
retorno.registros[].registro.idint-condicionalIdentificação da tag
retorno.registros[].registro.nomestring50condicionalNome da tag
retorno.registros[].registro.id_grupoint-condicionalID do grupo
retorno.registros[].registro.grupostring-condicionalNome 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"}]
  }
}