# API

***

## Autenticação

{% hint style="warning" %}
Esse procedimento envolve a autenticação do usuário, permitindo a realização das próximas requisições com parâmetros de segurança.
{% endhint %}

Ao acessar o swager [API documentation](http://public-doc.weclever.co.s3-website-us-east-1.amazonaws.com/), preencha os parâmetros como consta na imagem a abaixo:

<details>

<summary><mark style="background-color:orange;">Get</mark>    /solution/token/basic/{plataform_id} </summary>

Retorna um token complexo com base na autenticação básica.

**Parameters**\
\
**Name                                             Description**

platform\_id (path)                    Platform\_id\
string                                       &#x20;

time (query)                               Time parameter\
string                                           time          &#x20;

**Responses**

**Code                                              Description**

:green\_circle:200                                    Successful operation

&#x20;                                            &#x20;

</details>

Exemplo de Successful operation:

```json
{
  "token": "string"
}
```

***

## Seleção do server

{% hint style="success" %}
O acesso à API é feito através de um token de uso exclusivo enviado para cada cliente.
{% endhint %}

Ao acessar o swager [API documentation](http://public-doc.weclever.co.s3-website-us-east-1.amazonaws.com/), selecione o server em que deseja acionar a API.

{% hint style="info" %}
Caso queira testar antes de subir para produção, selecione a opção **Development server**.
{% endhint %}

<details>

<summary>Server</summary>

<https://dev-api.weclever.co> - Development server\
<https://api.weclever.co> - Production server

</details>

***

## Busca dos leads por data

{% hint style="info" %}
Essa chamada permite que você busque todos os leads com atendimentos finalizados entre uma data específica de início e fim.
{% endhint %}

Em seguida preencha os dados com os seguintes parâmetros:

<details>

<summary><mark style="background-color:orange;">Get</mark>    /lead/find/finalized/{firstDate}/{lastDate} </summary>

Get *Todos os leads finalizados entre duas datas*

Returns *Todos os leads finalizados entre duas datas*

**Parameters**\
\
**Name                                             Description**

First date (*path*)                    Date in the format YYYY-MM-DD or YYYY-MM-DD+HH:mm:ss

Last date (*path*)                    Date in the format YYYY-MM-DD or YYYY-MM-DD+HH:mm:ss

**Responses**

**Code                                              Description**

:green\_circle:200                                    Successful operation

&#x20;                                            &#x20;

</details>

&#x20;Exemplo de Successful operation:

{% code overflow="wrap" %}

```
  {"leads": [
    {
      "weclever_lead_id": 0,
      "mapped_status": "string",
      "client_lead_id": "Unknown Type: string,integer,null"
    }
  ]
} 


```

{% endcode %}

***

## Busca por informações do lead

{% hint style="info" %}
A próxima requisição, refere-se a busca por  todas as informações referentes aos leads através do weclever\_id.
{% endhint %}

<details>

<summary><mark style="background-color:orange;">Get</mark>   /lead/find/weclever_id/{id}</summary>

Get *todas as informações disponíveis do lead*\
Returns *todas as informações disponíveis do lead por weclever\_id*

**Parameters**

**Name                                             Description**

Id                                                     O parametro id é um número inteiro como 123456

**Responses**

**Code                                               Description**

:green\_circle:500                                    Successful operation.&#x20;

</details>

Exemplo:<br>

```json
{
  "lead": {
    "email": "string",
    "name": "string",
    "phone": "string",
    "state": "string",
    "regional": "string",
    "chats": {
      "metrics": {
        "date_difference": "string",
        "total_messages": 0
      },
      "messages": [
        {
          "id_chat": 0,
          "body": "string",
          "media_url": "string",
          "content_type": "string",
          "date_created": "string",
          "sid": "string",
          "message_type": "string",
          "direction": "string",
          "status": "string"
        }
      ]
    },
    "feelings": {
      "total_messages": 0,
      "positive_feeling": 0,
      "neutral_feeling": 0,
      "negative_feeling": 0
    },
    "csat": {
      "message": "string",
      "rating": "string"
    },
    "status": "string"
  }
}
```

Após os dados preenchidos selecione o ícone *<mark style="background-color:yellow;">try out</mark>* para receber as insformações solicitadas na requisição.

{% hint style="info" %}
Dúvidas em como realizar as integrações? Fale com nossa equipe pelo email <integracao@weclever.co> e vamos auxiliá-lo nesse processo! 🤗
{% endhint %}


---

# 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/exportacao-de-dados-para-crm/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.