Lista de Estágios do CRM API 2.0

Serviço destinado a fazer consulta de Pedidos.

Parâmetros do serviço

ElementoTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
formatostringobrigatórioFormato do retorno (json ou xml)

Retorno do serviço

ElementoTipoTamanhoOcorrênciaDescrição
retornoobject-obrigatórioElemento raiz do retorno
retorno.status_processamentoint-obrigatórioConforme tabela "Status de Processamento"
retorno.statusstring-obrigatórioContém o status do retorno “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo
retorno.codigo_erro (1)int-condicionalConforme tabela "Códigos de erro"
retorno.erros[ ](1) (3)list -condicional [0..n]Contém a lista dos erros encontrados.
retorno.erros[ ].errostring-condicionalMensagem contendo a descrição do erro
retorno.estagios[ ] (2)list -condicionalLista de resultados da pesquisa
retorno.estagios[ ].estagio (2)object-condicionalElemento utilizado para representar um assunto.
retorno.estagios[ ].estagio.codigoint-condicionalCódigo do estágio
retorno.estagios[ ].estagio.nomestring50condicionalNome do estágio

(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 de chamada da API

Exemplos da chamada em REST 


$url = 'https://SERVER_API_DIRapi2/crm.lista.estagios.assunto.php';
$token = 'coloque aqui a sua chave da api';
$pesquisa = 'xxxxx';
$data = "token=$token&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("listarEstagiosAssuntos", array('token' => 'xxxxx','formato'=>'XML'));

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

Exemplos de retorno da API

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>21</codigo_erro>
  <erros>
    <erro>A consulta retornou mais registros que o permitido</erro>
  </erros>
</retorno>

<?xml version="1.0" encoding="UTF-8"?>
<retorno>
  <status_processamento>3</status_processamento>
  <status>OK</status>
  <estagios>
    <estagio>
      <codigo>1</codigo>
      <nome>Prospecção</nome>
    </estagio>
    <estagio>
      <codigo>2</codigo>
      <nome>Contato realizado</nome>
    </estagio>
    <estagio>
      <codigo>3</codigo>
      <nome>Proposta apresentada</nome>
    </estagio>
    <estagio>
      <codigo>4</codigo>
      <nome>Negociação</nome>
    </estagio>
    <estagio>
      <codigo>5</codigo>
      <nome>Finalizado</nome>
    </estagio>
  </estagios>
</retorno>