Pesquisar Tag API 2.0

Serviço destinado a fazer consulta de Tags.

REST
SOAP

REST URL

SOAP WSDL

WSDL Service

Elemento	Tipo	Ocorrência	Descrição
token	string	obrigatório	Chave gerada para identificar sua empresa
formato	string	obrigatório	Formato do retorno (json ou xml)
pesquisa ⁽¹⁾	string	opcional	Nome ou parte do nome do grupo de tags que deseja consultar
idGrupo ⁽¹⁾	int	opcional	Número de identificação do grupo de tag no Tiny
pagina ⁽²⁾	int	opcional	Número da página

(1) - Ao menos um desses parâmetros deve ser informado.
(2) - Número da página que deseja obter (por padrão são listados 100 registros por página), caso não seja informado o valor padrão é 1.

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 ⁽¹⁾	int	-	condicional	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.pagina	int	-	obrigatório	Número da página que está sendo retornada
retorno.numero_paginas	int	-	obrigatório	Número de paginas do retorno
retorno.registros[ ] ⁽²⁾	list	-	condicional	Lista de resultados da pesquisa
retorno.registros[ ].registro ⁽²⁾	object	-	condicional	Elemento utilizado para representar uma Tag.
retorno.registros[ ].registro.id	int	-	condicional	Número de identificação da Tag no Tiny
retorno.registros[ ].registro.nome	string	50	condicional	Nome da Tag
retorno.registros[ ].registro.id_grupo	int	50	condicional	Número de identificação do Grupo da Tag no Tiny
retorno.registros[ ].registro.grupo	string	50	condicional	Nome do Grupo da Tag

(1) - Somente estará presente no retorno caso o elemento "status" seja "Erro".
(2) - Somente estará presente no retorno caso o elemento "status" seja "OK".
(3) - Estes campos somente serão informados caso o retorno contenha erros.

Exemplos da chamada em REST


$url = 'https://api.tiny.com.br/api2/tag.pesquisa.php';
$token = 'coloque aqui a sua chave da api';
$pesquisa = 'xxxxx';
$data = "token=$token&pesquisa=$pesquisa&formato=XML";

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;
}

Exemplos da chamada em SOAP


$client = new nusoap_client("https://api.tiny.com.br/api2.php?wsdl", true);
$client->soap_defencoding = 'UTF-8';
$client->decode_utf8 = false;

$result = $client->call("pesquisarTagService", array('token' => 'xxxxx','pesquisa'=>'xxxxx','formato'=>'XML'));

$res = array();
if ($client->fault) {
	$retorno = $result['faultstring'];		
} else {
	$err = $client->getError();
	if ($err) {
		$retorno = $err;	    	
	} else {
		$retorno = $result;
	}
}

Exemplos do retorno do serviço em JSON

Exemplos do retorno do serviço em XML

<?xml version="1.0" encoding="UTF-8"?>
<retorno>
  <status_processamento>1</status_processamento>
  <status>Erro</status>
  <codigo_erro>2</codigo_erro>
  <erros>
    <erro>token invalido</erro>
  </erros>
</retorno>

<?xml version="1.0" encoding="UTF-8"?>
<retorno>
  <status_processamento>2</status_processamento>
  <status>Erro</status>
  <codigo_erro>20</codigo_erro>
  <erros>
    <erro>A consulta nao retornou registros</erro>
  </erros>
</retorno>

<?xml version="1.0" encoding="UTF-8"?>
<retorno>
  <status_processamento>3</status_processamento>
  <status>OK</status>
  <registros>
    <registro>
      <id>46829060</id>
      <nome>nova </nome>
      <id_grupo>46829059</id_grupo>
      <grupo>Teste de Grupo 3</grupo>
    </registro>
  </registros>
</retorno>

Pesquisar Tag API 2.0

Parâmetros do serviço

Retorno do serviço

Exemplos de chamada da API

Exemplos da chamada em REST

Exemplos da chamada em SOAP

Exemplos de retorno da API

Exemplos do retorno do serviço em JSON

Exemplos do retorno do serviço em XML