API

A integração via API é ideal para desenvolvedores que desejam uma integração direta e automatizada. Utilize nossos endpoints dedicados para capturar leads em tempo real, com controle total sobre o processo de coleta.

---

Como acessar a API?

O acesso à API é feito através de um token de uso exclusivo enviado para cada cliente.

---

Inserção de um lead

URL
DEV: https://dev-api.weclever.co/lead
PROD: https://api.weclever.co/lead

Parâmetros

Nome	Descrição	Valor / exemplo	Obrigatório?
cs	Parâmetro fixo	1	Sim
csFingerprint	Fingerprint/ID do lead (necessário para a próxima etapa)	"123abc"	Sim
platform_lead_id	ID do lead, caso possua	“123456”	Não
id_platform	Identificador interno WeClever	TBD	Sim
csOrigin	Origem (mídia) do lead	“facebook”, “google”, etc	Não
name	Nome do cliente	John Doe	Sim
phone	Telefone do cliente	(11) 99999-8888	Sim
email	E-mail do cliente	[email protected]	Não
plugin	Identificador interno WeClever	TBD	Sim
action	Identificador interno WeClever	TBD	Sim

Exemplo de uso via curl

curl -X POST --header "Authorization: Bearer TBD" -d "cs&csFingerprint=123abc&id_platform=TBD&name=John&phone=(11)999998888&[email protected]&plugin=leads-abandono&action=venda" https://api.weclever.co/lead

Exemplo de payload

{
   "cs": 1,
   "csFingerprint": "123abc",
   "platform_lead_id": 123456,
   "id_platform": 612,
   "csOrigin": "web-site",
   "name": "John Doe",
   "phone": "(11) 99999-8888",
   "email": "[email protected]",
   "plugin": "",
   "action": "",
   "cpf": "28246934015",
   "product": "",
   "address": "",
   "city": "",
   "value": "",
   "mobile_device": ""
}

---

Negativar um lead que já efetuou a compra (Auto conversão)

URL:
DEV: https://dev-api.weclever.co/lead
PROD: https://api.weclever.co/lead

Parâmetros

Nome	Descrição	Valor / exemplo	Obrigatório?
csFingerprint	Fingerprint/ID do lead (mesmo utilizado na inserção)	"123abc"	Sim
id_platform	Identificador interno WeClever	TBD	Sim
status	Status	"lead_self_finished_sale"	Sim
plugin	Identificador interno WeClever	TBD	Sim
action	Identificador interno WeClever	TBD	Sim

Exemplo de uso via curl

curl -X POST --header "Authorization: Bearer TBD" -d "csFingerprint=123abc&id_platform=TBD&status=lead_self_finished_sale&plugin=checkout-concluido&action=venda" https://api.weclever.co/lead

Exemplo de payload

{
   "id_platform": 612,
   "csFingerprint": "123abc",
   "status": "lead_self_finished_sale",
   "plugin": "checkout-concluido",
   "action": "venda"
}

---

Observações

Além de todos os pontos destacados, segue uma lista de todos os atributos passíveis de serem adicionados. Para todos os dados que considerarem relevantes para a estratégia de operação, basta seguir o modelo e a lista de atributos abaixo:

Nome do Atributo	Nome da chave do payload
csFingerprint	csFingerprint
id_platform	Identificador interno WeClever
status	Status
plugin	Identificador interno WeClever
action	Identificador interno WeClever

Dúvidas?

Fale com nossa equipe: [email protected]