API HTTP addLead

Para prosseguir com o processo de consulta e integração, é necessário que o usuário tenha:

  • Cadastrado e-mail e CNPJ para testes ou adquirido um dos planos disponíveis.
  • Ter recebido sua chave de autenticação da API.

Tabela de conteúdo:


Para mais informações ou dúvidas: addlead.com.br

Como funciona a API

A API de integração addlead é uma simples URL que contem os parâmetros para iniciar uma requisição com a plataforma addlead e receber os dados higienizados.

URL

	https://api.addlead.com.br/doc_number/<CPF>?api_key=999999A-AAAA-9999-AA99-A9999A9999AA

Metodo: GET

A URL é composta por 3 campos de informações necessárias para que seja feita a autenticação e consulta em nossa plataforma:

  • Endereço addlead
  • Documento
  • Chave de Autenticação

O documento será o CPF ou CNPJ a ser consultado.
A chave de autenticação é enviada por e-mail após cadastro em algum dos planos disponíveis


Para mais informações ou dúvidas: addlead.com.br

Exemplos API

Exemplos

Considerando o cenário:

  • Consulta de CPF 103.701.976-36*
  • Chave de autenticação 999999A-AAAA-9999-AA99-A9999A9999AA

Exemplo no navegador

Insira no navegador de sua preferência a URL completa**

https://api.addlead.com.br/doc_number/10370197636?api_key=999999A-AAAA-9999-AA99-A9999A9999AA

A API retornará em seguida o resultado da consulta, que serão os números de telefone encontrados a partir do documento enviado.

31971807969 31979521597 31951462597

Observação¹: Em relação ao documento, devem ser inseridos apenas números na URL.
Observação²: Apesar de o exemplo acima ser uma consulta individual, a API suporta o mesmo tipo de requisição também em lotes via integração com vasta quantidade de sistemas. Veja no próximo tópico exemplos de integração em lotes.

Exemplo no shell

~$ curl -X GET -k -L "https://api.addlead.com.br/doc_number/10370197636?api_key=999999A-AAAA-9999-AA99-A9999A9999AA"
31971807969 31979521597 31951462597

Para mais informações ou dúvidas: addlead.com.br

Integração

Conforme já mencionado nossa plataforma suporta requisições em lote utilizando a url.
A requisição é simples, sem haver necessidade de softwares terceiros além dos básicos que acompanham cada sistema. Logo, é facilmente integravel com inúmeras plataformas. Incluindo, por exemplo, plataformas de discagem autmática para Call Centers como Vici Dial, plataformas de telefonia como Asterisk e também inegração com diferentes sistemas operacionais.

Exemplos de integração

Abaixo, mostraremos alguns exemplos de integração com diferentes sistemas, tanto para armazenar os dados retornados em diferentes locais quanto para executar diretamente ligações em plataformas de telefonia.

Considerando o conteúdo de doc_file:

10370197636;10421945822;15765863589;15624587962

Nos exemplos abaixo, vamos entrar em loop no doc_file e fazer uma requisição para cada documento no arquivo.

Shell Script

#!/bin/bash

#
# Script header
#

OLDFS=${IFS}
IFS=';'
DOC_FILE=/tmp/doc_file
MY_KEY=1f7bb1dd-2285-11ea-8da5-9c8e992b1e90
LEADS_LIST=/tmp/leads_list
RESULT=''

	for document in $(cat ${DOC_FILE}); do
		RESULT="curl -k -L \"https://api.addlead.com.br/doc_number/${document}?api_key=${MY_KEY}\""
		if [[ $? -eq 0 ]]; then
			echo "${document}=${RESULT}\;" >> ${LEADS_LIST}
	done

Conteúdo de /tmp/leads_list:

10370197636=981538965;10421945822=897513258;15765863589=994257852;15624587962=893245312;

Para mais informações ou dúvidas: addlead.com.br