---
title: "Requests: API da plataforma"
description: "API da plataforma APIBrasil (Gerenciamento de requisições). Os endpoints abaixo são os da conta e da operação do gateway."
lang: pt-BR
canonical: https://doc.apibrasil.io/apis/plataforma/requests
markdown: https://doc.apibrasil.io/apis/plataforma/requests.md
source: apibrasil-documentation
---

# Requests: API da plataforma

> API da plataforma APIBrasil (Gerenciamento de requisições). Os endpoints abaixo são os da conta e da operação do gateway.

- **Especificação OpenAPI:** https://doc.apibrasil.io/apis/plataforma/requests/openapi.json

## Como chamar

**Endereço base:** `https://gateway.apibrasil.io/api/v2`

## Endpoints (2 endpoints)

### 1. POST /devices/requests

Com esse endpoint é possivel obter os dados das requisições via API

- **Método:** `POST`
- **Endereço:** `https://gateway.apibrasil.io/api/v2/devices/requests`
- **Versão da rota:** v2

**Cabeçalhos**

| Cabeçalho | Valor |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**Em cURL**

```bash
curl -X POST "https://gateway.apibrasil.io/api/v2/devices/requests" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $APIBRASIL_TOKEN"
```

**Resposta de exemplo, do catálogo**

```json
{
  "device_token": "eefed067-3959-409d-a10a-d6b46a8e3144",
  "device_name": "dasdasdsadsa",
  "last_activity": "há 5 dias",
  "api": {
    "name": "Evolution API Baileys",
    "limit": 7,
    "for": "device",
    "cicle": "month"
  },
  "requests": {
    "total": 8,
    "total_today": 0,
    "total_month": 8,
    "total_last_hour": 0
  },
  "count": {
    "sendText": 1,
    "sendImage": 0,
    "sendAudio": 0,
    "sendFile": 0,
    "sendMedia": 2,
    "sendVideo": 0,
    "getAllChats": 0,
    "connectionState": 5,
    "connectionStatus": 0,
    "dados": 0,
    "rastreio": 0,
    "cpf": 0,
    "cnpj": 0,
    "cep": 0,
    "sms": 0,
    "fipe": 0
  }
}
```

### 2. POST /requests/paginate

Com esse endpoint é possivel obter informações do usuario

- **Método:** `POST`
- **Endereço:** `https://gateway.apibrasil.io/api/v2/requests/paginate`
- **Versão da rota:** v2

**Cabeçalhos**

| Cabeçalho | Valor |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**Em cURL**

```bash
curl -X POST "https://gateway.apibrasil.io/api/v2/requests/paginate" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $APIBRASIL_TOKEN"
```

**Resposta de exemplo, do catálogo**

```json
{
  "requests_count": 60,
  "requests_last_hour": 7,
  "requests": {
    "current_page": 1,
    "data": [
      {
        "action": "sendText",
        "response": "{\"response\":false,\"status\":\"Disconnected\",\"message\":\"A inst\\u00e2ncia do WhatsApp informada n\\u00e3o est\\u00e1 conectada.\"}",
        "created_at": "2023-08-23T22:28:59.000000Z"
      },
      {
        "url": "https://cluster.apigratis.com/api/v2/requests/paginate?page=2",
        "label": "pagination.next",
        "active": false
      }
    ],
    "next_page_url": "https://cluster.apigratis.com/api/v2/requests/paginate?page=2",
    "path": "https://cluster.apigratis.com/api/v2/requests/paginate",
    "per_page": 10,
    "prev_page_url": null,
    "to": 10,
    "total": 60
  }
}
```

## Ver também

- Especificação OpenAPI: https://doc.apibrasil.io/apis/plataforma/requests/openapi.json
- Catálogo de APIs: [Catálogo de APIs](https://doc.apibrasil.io/apis.md)
- SDKs oficiais: [SDKs oficiais](https://doc.apibrasil.io/sdks.md)
- Índice da documentação: https://doc.apibrasil.io/llms.txt
- Versão HTML desta página: https://doc.apibrasil.io/apis/plataforma/requests
