Postman

https://www.postman.com/docs/
Admin
Postman is an API platform that simplifies each step of the API lifecycle and streamlines...
Tokens:4,893
Snippets:44
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### GET /api/v2/servers

Source: https://www.postman.com/docs-apibrasil/ambiente-apibrasil/request/8pqn30o/lista-todos

Retrieves a list of all servers. This endpoint does not require any parameters.

```APIDOC
## GET /api/v2/servers

### Description
Retrieves a list of all servers.

### Method
GET

### Endpoint
{{APIV2}}/api/v2/servers

### Parameters
None

### Response
#### Success Response (200)
No response schema provided.

#### Response Example
No response example provided.
```

--------------------------------

### GET Fatura

Source: https://www.postman.com/docs-apibrasil/ambiente-apibrasil/request/edaghcc/fatura

Documentation for the GET Fatura endpoint, which retrieves a specific invoice from the APIBrasil Gateway V2 platform.

```APIDOC
## GET Fatura

### Description
Retrieves a specific invoice (fatura) from the APIBrasil Gateway V2 platform. This endpoint is part of the Faturas (Invoices) collection and allows users to fetch invoice details by its identifier.

### Method
GET

### Endpoint
Fatura

### Parameters
No parameters are explicitly documented in the source.

### Request Example
No request body is required for this GET request.

### Response
#### Success Response (200)
No response schema is explicitly documented in the source.

#### Response Example
No response example is provided in the source.
```

--------------------------------

### GET Lista Operadoras

Source: https://www.postman.com/docs-apibrasil/ambiente-apibrasil/request/8s1vgj2/lista-operadoras

Retrieves a list of mobile operators. This endpoint is used to obtain the available operators for chip virtual operations.

```APIDOC
## GET Lista Operadoras

### Description
Retrieves a list of mobile operators available in the APIBrasil Chip Virtual API.

### Method
GET

### Endpoint
Lista Operadoras

### Parameters
No parameters documented.

### Request Example
No request body required.

### Response
#### Success Response (200)
No response schema documented.

#### Response Example
No response example provided.
```

--------------------------------

### POST /api/v2/consulta/cpf/credits

Source: https://www.postman.com/docs-apibrasil/ambiente-apibrasil/request/2enfhmz/consulta

Documentação da operação POST para consulta de crédito de CPF via SPC Boa Vista.

```APIDOC
## [POST] /api/v2/consulta/cpf/credits

### Description
Consulta informações de crédito de um CPF através do serviço SPC Boa Vista.

### Method
POST

### Endpoint
`{{APIV2}}/api/v2/consulta/cpf/credits`

### Parameters
#### Headers
- **Authorization** (string) - Required - Token de autenticação da API.

### Request Example
```json
{
  "cpf": "12345678900"
}
```

### Response
#### Success Response (200)
- **status** (string) - Status da consulta.
- **data** (object) - Dados retornados pela consulta.

#### Response Example
```json
{
  "status": "success",
  "data": {}
}
```
```

--------------------------------

### POST /api/v2/fipe/ConsultarAnoModelo

Source: https://www.postman.com/docs-apibrasil/ambiente-apibrasil/request/yu0paat/consultaranomodelo

Endpoint para consultar os anos de um modelo de veículo na tabela FIPE. Utiliza o método POST e requer autenticação via headers.

```APIDOC
## [POST] /api/v2/fipe/ConsultarAnoModelo

### Description
Consulta os anos disponíveis para um modelo de veículo na tabela FIPE.

### Method
POST

### Endpoint
{{APIV2}}/api/v2/fipe/ConsultarAnoModelo

### Parameters
#### Headers
- **Authorization** (string) - Required - Token de autenticação para acesso à API.

### Request Example
(Exemplo de corpo de requisição não fornecido no texto original.)

### Response
#### Success Response (200)
(Detalhes da resposta não fornecidos no texto original.)

#### Response Example
(Exemplo de resposta não fornecido no texto original.)
```

--------------------------------

### POST {{APIV2}}/api/v2/whatsapp/sendFile64

Source: https://www.postman.com/docs-apibrasil/ambiente-apibrasil/request/8x9xbai/send-file64

Documentation for the Send File64 endpoint in the APIBrasil WhatsApp API.

```APIDOC
## [POST] {{APIV2}}/api/v2/whatsapp/sendFile64

### Description
Sends a WhatsApp message with a file encoded in base64. The endpoint is part of the APIBrasil Gateway V2 WhatsApp API.

### Method
POST

### Endpoint
{{APIV2}}/api/v2/whatsapp/sendFile64

### Parameters
#### Request Body
- **file64** (string) - Required - The base64-encoded file content.
- **caption** (string) - Optional - A caption for the file.
- **number** (string) - Required - The recipient's phone number.

### Request Example
{
  "file64": "base64_encoded_string",
  "caption": "Optional caption",
  "number": "5511999999999"
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **message** (string) - A message describing the result.

#### Response Example
{
  "success": true,
  "message": "Message sent successfully"
}
```

--------------------------------

### POST {{APIV2}}/api/v2/dados/cnpj/credits

Source: https://www.postman.com/docs-apibrasil/ambiente-apibrasil/request/5064qn8/lista-scios-por-cnpj

Documentation for the Lista Sócios por CNPJ endpoint, which retrieves partner information for a given CNPJ using the APIBrasil Gateway V2.

```APIDOC
## [POST] {{APIV2}}/api/v2/dados/cnpj/credits

### Description
This endpoint lists partners (sócios) for a given CNPJ. It is part of the API CNPJ - C/ Saldo collection under the APIBrasil Gateway V2.

### Method
POST

### Endpoint
{{APIV2}}/api/v2/dados/cnpj/credits

### Parameters
#### Headers
- **Authorization** (string) - Required - Authentication token for the API.

#### Request Body
- **cnpj** (string) - Required - The CNPJ number to query partners for.

### Request Example
{
  "cnpj": "12345678000195"
}

### Response
#### Success Response (200)
- **socios** (array) - List of partners associated with the CNPJ.

#### Response Example
{
  "socios": [
    {
      "nome": "Nome do Sócio",
      "cpf": "12345678900"
    }
  ]
}
```

--------------------------------

### POST {{APIV2}}/api/v2/evolution/chat/whatsappNumbers

Source: https://www.postman.com/docs-apibrasil/ambiente-apibrasil/request/r69ti4q/chat

Documentation for the POST endpoint that retrieves WhatsApp numbers from the chat API.

```APIDOC
## POST {{APIV2}}/api/v2/evolution/chat/whatsappNumbers

### Description
This endpoint retrieves WhatsApp numbers associated with the chat. It is part of the Chat API in the APIBrasil Gateway V2.

### Method
POST

### Endpoint
{{APIV2}}/api/v2/evolution/chat/whatsappNumbers

### Parameters
No parameters are documented in the source.

### Request Example
No request body is documented in the source.

### Response
No response schema is documented in the source.

### Response Example
No response example is documented in the source.
```

--------------------------------

### POST Dados por DDD

Source: https://www.postman.com/docs-apibrasil/ambiente-apibrasil/request/57ekm6s/dados-por-ddd

Documentação do endpoint POST Dados por DDD da API - DDD Anatel, que retorna informações sobre um DDD brasileiro.

```APIDOC
## [POST] Dados por DDD

### Description
Obtém dados de um DDD (código de área) brasileiro, retornando informações como estado, região e outras referências associadas ao DDD consultado.

### Method
POST

### Endpoint
`/api/v2/ddd/{ddd}`

### Parameters
#### Path Parameters
- **ddd** (string) - Obrigatório - O código DDD a ser consultado.

### Request Example
```json
{
  "ddd": "11"
}
```

### Response
#### Success Response (200)
- **ddd** (string) - O código DDD consultado.
- **estado** (string) - O estado (UF) correspondente ao DDD.
- **regiao** (string) - A região do Brasil correspondente ao DDD.

#### Response Example
```json
{
  "ddd": "11",
  "estado": "SP",
  "regiao": "Sudeste"
}
```
```

--------------------------------

### POST {{APIV2}}/api/v2/whatsapp/getAllGroups

Source: https://www.postman.com/docs-apibrasil/ambiente-apibrasil/request/af8trj5/get-all-groups

API endpoint to retrieve all WhatsApp groups.

```APIDOC
## [POST] {{APIV2}}/api/v2/whatsapp/getAllGroups

### Description
Retrieves all WhatsApp groups associated with the authenticated account.

### Method
POST

### Endpoint
{{APIV2}}/api/v2/whatsapp/getAllGroups

### Parameters
#### Headers
- **Authorization** (string) - Required - Authentication token for API access.

### Response
#### Success Response (200)
- **groups** (array) - List of WhatsApp groups.

#### Response Example
{
  "groups": []
}
```

--------------------------------

### POST /api/v2/nf/create

Source: https://www.postman.com/docs-apibrasil/ambiente-apibrasil/request/cqc2flt/emite-nota-fiscal

Creates a new fiscal note (nota fiscal) using the APIBrasil Gateway V2. This endpoint is used to emit a fiscal note with the provided data.

```APIDOC
## POST /api/v2/nf/create

### Description
Creates a new fiscal note (nota fiscal) using the APIBrasil Gateway V2.

### Method
POST

### Endpoint
{{APIV2}}/api/v2/nf/create

### Parameters
No parameters documented.

### Request Example
No request body example provided.

### Response
No response example provided.
```

--------------------------------

### POST getGroupInfoFromInviteLink

Source: https://www.postman.com/docs-apibrasil/ambiente-apibrasil/request/r8w2lnw/getgroupinfofrominvitelink

Retrieves group information from an invite link. Use this endpoint to obtain details about a WhatsApp group by providing the invite link.

```APIDOC
## POST getGroupInfoFromInviteLink

### Description
Retrieves group information from an invite link.

### Method
POST

### Endpoint
getGroupInfoFromInviteLink

### Parameters
#### Request Body
- **inviteLink** (string) - Required - The invite link of the WhatsApp group.

### Request Example
{
  "inviteLink": "https://chat.whatsapp.com/example"
}

### Response
#### Success Response (200)
- **groupInfo** (object) - Details of the group.

#### Response Example
{
  "groupInfo": {
    "id": "group-id",
    "name": "Group Name",
    "description": "Group description"
  }
}
```

--------------------------------

### POST {{APIV2}}/api/v2/dados/cpf/credits

Source: https://www.postman.com/docs-apibrasil/ambiente-apibrasil/request/8cbohp5/consulta

Consulta endpoint for CPF data credits. This endpoint is used to check the available credits for CPF data queries.

```APIDOC
## [POST] {{APIV2}}/api/v2/dados/cpf/credits

### Description
Consulta endpoint for CPF data credits. This endpoint is used to check the available credits for CPF data queries.

### Method
POST

### Endpoint
{{APIV2}}/api/v2/dados/cpf/credits

### Parameters
#### Path Parameters
- **APIV2** (string) - Required - Base URL for the API environment.

### Response
#### Success Response (200)
- **credits** (number) - Available credits for CPF data queries.

#### Response Example
{
  "credits": 100
}
```

--------------------------------

### POST Add Participant

Source: https://www.postman.com/docs-apibrasil/ambiente-apibrasil/request/stftzqo/add-participant

Documentation for the Add Participant endpoint in the APIBrasil WhatsApp Groups API.

```APIDOC
## POST Add Participant

### Description
Adds a participant to a WhatsApp group using the APIBrasil Gateway V2.

### Method
POST

### Endpoint
Add Participant

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
No response schema documented.
```

--------------------------------

### POST /api/v2/vehicles/base/001/consulta

Source: https://www.postman.com/docs-apibrasil/ambiente-apibrasil/request/v05b0hb/leilo-score

Consulta informações de leilão e score de um veículo na Base 001. O endpoint aceita um identificador de veículo e retorna dados detalhados.

```APIDOC
## [POST] /api/v2/vehicles/base/001/consulta

### Description
Consulta informações de leilão e score de um veículo na Base 001.

### Method
POST

### Endpoint
/api/v2/vehicles/base/001/consulta

### Parameters
#### Path Parameters
- **base** (string) - Obrigatório - Identificador da base de consulta (ex: 001).

#### Query Parameters
- **id** (string) - Obrigatório - Identificador do veículo a ser consultado.

### Request Example
```json
{
  "id": "123456"
}
```

### Response
#### Success Response (200)
- **leilao** (object) - Dados do leilão do veículo.
- **score** (object) - Dados de score do veículo.

#### Response Example
```json
{
  "leilao": {
    "data": "2023-01-01",
    "local": "São Paulo"
  },
  "score": {
    "pontuacao": 850,
    "classificacao": "Excelente"
  }
}
```
```

--------------------------------

### POST Send Audio

Source: https://www.postman.com/docs-apibrasil/ambiente-apibrasil/request/2a5up8y/send-audio

Sends an audio message to a WhatsApp contact. The request must include the audio file and recipient details.

```APIDOC
## POST Send Audio

### Description
Sends an audio message to a WhatsApp contact using the APIBrasil Gateway V2.

### Method
POST

### Endpoint
Send Audio

### Parameters
#### Headers
- **Authorization** (string) - Required - Authentication token.
- **Content-Type** (string) - Required - Must be set to `application/json`.

#### Request Body
- **audio** (file) - Required - The audio file to send.
- **to** (string) - Required - The recipient's phone number.

### Request Example
```json
{
  "audio": "base64-encoded-audio",
  "to": "5511999999999"
}
```

### Response
#### Success Response (200)
- **status** (string) - Status of the request.
- **message** (string) - Response message.

#### Response Example
```json
{
  "status": "success",
  "message": "Audio sent successfully"
}
```
```

--------------------------------

### POST sendText

Source: https://www.postman.com/docs-apibrasil/ambiente-apibrasil/request/e8b6e7j/sendtext

Documentation for the sendText endpoint in the APIBrasil Gateway V2 WhatsApp API, part of the Filas (queues) beta feature.

```APIDOC
## POST sendText

### Description
Sends a text message through the WhatsApp API using the APIBrasil Gateway V2. This endpoint is part of the Filas (queues) beta feature.

### Method
POST

### Endpoint
sendText

### Parameters
No parameters documented.

### Request Example
No request example provided.

### Response
No response example provided.
```

--------------------------------

### POST VerifyNumber

Source: https://www.postman.com/docs-apibrasil/ambiente-apibrasil/request/efbzmaw/verifynumber

Verifies a WhatsApp number using the APIBrasil Gateway V2. This endpoint is part of the Messages API and requires appropriate authorization and headers.

```APIDOC
## POST VerifyNumber

### Description
Verifies a WhatsApp number using the APIBrasil Gateway V2. This endpoint is part of the Messages API and requires appropriate authorization and headers.

### Method
POST

### Endpoint
VerifyNumber

### Parameters
#### Headers
- **Authorization** (string) - Required - Authentication token for API access.
- **Content-Type** (string) - Required - The media type of the request body (e.g., application/json).

#### Request Body
- **number** (string) - Required - The WhatsApp number to verify.

### Request Example
{
  "number": "5511999999999"
}

### Response
#### Success Response (200)
- **status** (string) - Status of the verification (e.g., "valid").
- **number** (string) - The verified number.

#### Response Example
{
  "status": "valid",
  "number": "5511999999999"
}
```

--------------------------------

### POST /api/v2/vehicles/base/000/dados

Source: https://www.postman.com/docs-apibrasil/ambiente-apibrasil/request/ch1uwxi/placa-dados-92-nacional

Retrieves vehicle data based on a license plate. This endpoint provides 92% national coverage and requires authentication via API key.

```APIDOC
## POST /api/v2/vehicles/base/000/dados

### Description
Retrieves vehicle data based on a license plate. This endpoint provides 92% national coverage and requires authentication via API key.

### Method
POST

### Endpoint
/api/v2/vehicles/base/000/dados

### Parameters
#### Headers
- **Authorization** (string) - Required - API key for authentication.

#### Request Body
- **placa** (string) - Required - The license plate of the vehicle to query.

### Request Example
{
  "placa": "ABC1234"
}

### Response
#### Success Response (200)
- **data** (object) - Vehicle data returned by the API.

#### Response Example
{
  "data": {
    "placa": "ABC1234",
    "marca": "Fiat",
    "modelo": "Uno"
  }
}
```

--------------------------------

### POST Revoke Invite Code

Source: https://www.postman.com/docs-apibrasil/ambiente-apibrasil/request/cacp9u9/revoke-invite-code

Revokes an invite code for a WhatsApp group. This endpoint is part of the Groups section of the APIBrasil Gateway V2 API.

```APIDOC
## POST Revoke Invite Code

### Description
Revokes an invite code for a WhatsApp group.

### Method
POST

### Endpoint
Revoke Invite Code

### Parameters
No parameters documented.

### Request Example
No request body documented.

### Response
No response schema documented.

### Response Example
No response example documented.
```
Tokens:
Raw