Alterar Tag API 2.0

Serviço destinado a fazer alteração 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
tag ⁽¹⁾	-	obrigatório	Dados do tag conforme layout
formato	string	obrigatório	Formato do retorno (json ou xml)

(1) - Layout do parâmetro tag

Elemento	Tipo	Tamanho	Ocorrência	Descrição
tags[ ]	list	-	obrigatório	Elemento raiz utilizado para representar um conjunto de Tags.
tags[ ].tag	object	-	obrigatório	Elemento utilizado para representar uma Tag.
tags[ ].tag.sequencia	inteiro	-	obrigatório	Número sequencial utilizado para identificar cada tag.
tags[ ].tag.id ⁽¹⁾	inteiro	-	obrigatório	Número de identificação da Tag no Tiny.
tags[ ].tag.nome	string	50	obrigatório	Nome da Tag.
tags[ ].tag.id_grupo	inteiro	-	obrigatório	Número de indentificação da Grupo de Tag no Tiny.

(1) - Este campo é utilizado para localizar a tag que será alterada.

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.registros[ ] ⁽²⁾	list	-	condicional	Lista de resultados da alteração
retorno.registros[ ].registro ⁽²⁾	object	-	condicional	Elemento utilizado para representar uma Tag.
retorno.registros[ ].registro.sequencia	int	-	condicional	Número sequencial utilizado para identificar cada tag.
retorno.registros[ ].registro.status	string	-	condicional	Contém o status do registro “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo
retorno.registros[ ].registro.codigo_erro	int	-	condicional	Conforme tabela "Códigos de erro"
retorno.registros[ ].registro.erros[ ] ⁽³⁾	list	-	condicional [0..n]	Contém a lista dos erros encontrados.
retorno.registros[ ].registro.erros[ ].erro	string	-	condicional	Mensagem contendo a descrição do erro
retorno.registros[ ].registro.id	int	-	condicional	Número de identificação da Tag no Tiny

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

Exemplos do parâmetro tag em JSON

Exemplos do parâmetro tag em XML

<?xml version="1.0" encoding="UTF-8"?>
<tags>
  <tag>
    <sequencia>1</sequencia>
    <id>46829154</id>
    <nome>Tag Teste 21</nome>
    <id_grupo>46829059</id_grupo>
  </tag>
  <tag>
    <sequencia>2</sequencia>
    <id>46829155</id>
    <nome>Tag Teste 22</nome>
    <id_grupo>46829059</id_grupo>
  </tag>
</tags>

Exemplos da chamada em REST


$url = 'https://SERVER_API_DIRapi2/tag.alterar.php';
$token = 'coloque aqui a sua chave da api';
$tag = '<tags>...</tags>';
$data = "token=$token&tag=$tag&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://SERVER_API_DIRapi2.php?wsdl", true);
$client->soap_defencoding = 'UTF-8';
$client->decode_utf8 = false;

$result = $client->call("alterarTagService", array('token' => 'xxxxx','tag'=>'<tags>...</tags>','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>
  <registros>
    <registro>
      <sequencia>1</sequencia>
      <status>Erro</status>
      <codigo_erro>30</codigo_erro>
      <erros>
        <erro>Registro em duplicidade</erro>
      </erros>
    </registro>
    <registro>
      <sequencia>2</sequencia>
      <status>Erro</status>
      <codigo_erro>30</codigo_erro>
      <erros>
        <erro>Registro em duplicidade</erro>
      </erros>
    </registro>
  </registros>
</retorno>

<?xml version="1.0" encoding="UTF-8"?>
<retorno>
  <status_processamento>3</status_processamento>
  <status>OK</status>
  <registros>
    <registro>
      <sequencia>1</sequencia>
      <status>OK</status>
      <id>37644544</id>
    </registro>
    <registro>
      <sequencia>2</sequencia>
      <status>OK</status>
      <id>37644545</id>
    </registro>
  </registros>
</retorno>

Alterar Tag API 2.0

Parâmetros do serviço

(1) - Layout do parâmetro tag

Retorno do serviço

Exemplos do parâmetro tag