API - Passos básicos para exportação de Leads (Postman)

Atualmente no Spotter temos duas formas de exportar Leads: pelo Spotter diretamente ou via API. Neste artigo, trataremos da exportação de Leads via API com Postman (caso não tenha ele instalado, pode baixar clicando aqui). 

Após realizar o download, abrindo o Postman clique em "Collections" > + > Atribua um nome a essa pasta (onde ficarão as requisições) > clique nos três pontinhos > Add Request:

O primeiro passo é identificar a documentação correta, a partir disso teremos o EndPoint a ser utilizado. Se tratando de uso do Spotter V2, esta é a documentação a ser utilizada:  https://exactspotter.docs.apiary.io/#/reference/0/leads-listagem

Após acessar a documentação, localize no Postman onde inserir o EndPoint e os Headers:

IMPORTANTE: O Token é encontrado no Spotter acessando o menu lateral esquerdo "Configurações" > Integrações > Token Exact API.

Preenchendo desta forma já é possível retirar os Leads do Spotter. Após isso, podemos utilizar o protocolo OData para filtrar/ordenar/etc. Para aplicar um filtro pelo ID do Lead, por exemplo, adicione a chave em "Params" e valor Id eq:

As listagens via API atualmente possuem uma limitação de 500 Leads por página e os dados vêm em ordem de Leads mais antigos para mais novos. Para retirar listagem em ordem decrescente ao invés de ascendente, utilize o parâmetro $orderby:

Outro filtro comumente utilizado é a Origem. Neste caso, a requisição é feita com a chave $filter,  o valor utilizado contém o nome da origem, ficando desta forma:

IMPORTANTE: Não há paginação, porém há um limite de 500 Leads por envio. Nesse caso é necessário utilizar o $skip para poder listar os próximos Leads.

Caso esteja procurando um Lead específico pela API, é possível utilizar o $filter pelo id do Lead, assim irá retornar já com o Lead desejado.

Até a próxima!