# 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

<table><thead><tr><th width="181">Nome</th><th>Descrição</th><th width="240">Valor / exemplo</th><th>Obrigatório?</th></tr></thead><tbody><tr><td>cs</td><td>Parâmetro fixo</td><td>1</td><td>Sim</td></tr><tr><td>csFingerprint</td><td>Fingerprint/ID do lead (necessário para a próxima etapa)</td><td>"123abc"</td><td>Sim</td></tr><tr><td>platform_lead_id</td><td>ID do lead, caso possua</td><td>“123456”</td><td>Não</td></tr><tr><td>id_platform</td><td>Identificador interno WeClever</td><td>TBD</td><td>Sim</td></tr><tr><td>csOrigin</td><td>Origem (mídia) do lead</td><td>“facebook”, “google”, etc</td><td>Não</td></tr><tr><td>name</td><td>Nome do cliente</td><td>John Doe</td><td>Sim</td></tr><tr><td>phone</td><td>Telefone do cliente</td><td>(11) 99999-8888</td><td>Sim</td></tr><tr><td>email</td><td>E-mail do cliente</td><td>johndoe@example.com</td><td>Não</td></tr><tr><td>plugin</td><td>Identificador interno WeClever</td><td>TBD</td><td>Sim</td></tr><tr><td>action</td><td>Identificador interno WeClever</td><td>TBD</td><td>Sim</td></tr></tbody></table>

#### Exemplo de uso via curl

{% code overflow="wrap" %}

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

{% endcode %}

#### 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": "johndoe@example.com",
   "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

{% code overflow="wrap" %}

```
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
```

{% endcode %}

#### 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 |

{% hint style="info" %}
**Dúvidas?**&#x20;

Fale com nossa equipe: <integracao@weclever.co>
{% endhint %}

<br>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.weclever.co/documentacao/integracoes-para-captura-de-leads/api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.