> For the complete documentation index, see [llms.txt](https://docs.api.zap.ilio.me/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.api.zap.ilio.me/api-v1.md).

# API V1

{% hint style="info" %}
Nosso guia de início rápido está disponível para ajudá-lo a utilizar nossos endpoints de integração. Com ele, você poderá começar a utilizar nossos serviços de forma rápida e fácil, sem precisar ler toda a documentação detalhada.

{% endhint %}

## Disparo via Postback

Através do postback, o token da requisição é enviado na URL. Para que isso funcione corretamente, é necessário cadastrar um template na plataforma que irá identificar a requisição.

<figure><img src="/files/gTFrsvZrCBPIh24R8Dyc" alt=""><figcaption></figcaption></figure>

## POSTBACK

<mark style="color:green;">`POST`</mark> `https://api.zap.ilio.me/v1/gateway/postback/simples/token/`

Ao cadastrar um Postback simples na Plataforma Zapilio, copie o evento **@seu\_template** e passe o parâmetro através da sua requisição.

#### Request Body

| Name                                         | Type   | Description                  |
| -------------------------------------------- | ------ | ---------------------------- |
| template<mark style="color:red;">\*</mark>   | string | Template definido na Zapilio |
| cus\_name<mark style="color:red;">\*</mark>  | string | Nome do Lead                 |
| cus\_cel<mark style="color:red;">\*</mark>   | string | WhatsApp do Lead             |
| cus\_phone                                   | string | Telefone do Lead             |
| cus\_email<mark style="color:red;">\*</mark> | string | E-mail do laed               |

{% tabs %}
{% tab title="200 Webhook recebido e processado com sucesso." %}

```javascript
{
    "name"="Wilson",
    "owner": {
        "id": "sha7891bikojbkreuy",
        "name": "Samuel Passet",
    "species": "Dog",}
    "breed": "Golden Retriever",
}
```

{% endtab %}

{% tab title="401 Erro ao receber webhook" %}

{% endtab %}
{% endtabs %}

{% hint style="success" %}
**Importante:** Este método utiliza o postback definido na plataforma para processar mensagens. Isso significa que você precisa cadastrar um postback na plataforma para reconhecê-lo e definir ações ao recebê-lo
{% endhint %}

## **Disparo via API**

Se você deseja utilizar a API de envio de mensagens para realizar disparos imediatos, obtenha o seu token de integração. Vá até a plataforma Zapilio, procure pelo botão de **engrenagem** ao lado das informações da conta, logo depois clique no botão Perfil ( ⚙️ -> Perfil ). \
Ao acessar a página de Perfil, clique na aba automação e copie o token da sua conta.

<figure><img src="/files/L24PdVD71fJQ7wlUL5DL" alt=""><figcaption></figcaption></figure>

## DISPARO

<mark style="color:green;">`POST`</mark> `https://api.zap.ilio.me/v1/disparo/token/`

O tipo será texto, o conteúdo na body será sua mensagem e o destinatário o número do contato com DDI E DDD

#### Request Body

| Name                                           | Type   | Description          |
| ---------------------------------------------- | ------ | -------------------- |
| destinatario<mark style="color:red;">\*</mark> | string | 5511970707070        |
| body<mark style="color:red;">\*</mark>         | string | Conteúdo da mensagem |
| tipo<mark style="color:red;">\*</mark>         | string | texto                |

{% tabs %}
{% tab title="200 Requisição recebida e processado com sucesso." %}

```javascript
{
    "name"="Wilson",
    "owner": {
        "id": "sha7891bikojbkreuy",
        "name": "Samuel Passet",
    "species": "Dog",}
    "breed": "Golden Retriever",
}
```

{% endtab %}

{% tab title="401 Erro ao processar solicitação, verifique o retorno com o parâmetro inválido" %}

{% endtab %}
{% endtabs %}