> For the complete documentation index, see [llms.txt](https://docs.otima.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.otima.io/whatsapp/recursos-de-api/postman-exemplos-da-api-do-whatsapp-oficial.md).

# Postman — exemplos da API do WhatsApp Oficial

#### Visão Geral

A Collection do Postman da WhatsApp Oficial Ótima reúne os endpoints necessários para envios e consultas com a Meta.

Por meio desta collection, podem explorar, testar e validar rapidamente as funcionalidades disponíveis, utilizando exemplos prontos de requisições e respostas.

***

#### **Download**

Faça o download da collection disponibilizada abaixo e importe-a no Postman para explorar e testar todos os recursos da API Oficial.

{% file src="/files/gXCo343P2pzG6o8YB22B" %}

#### O que está incluído

A collection contempla os recursos disponibilizados pela API Oficial Meta, organizados em pastas e requisições para facilitar a navegação e o consumo dos serviços.

Entre os principais grupos de funcionalidades estão:

* Gerenciamento de instâncias
* Envio de mensagens
* Consultas e validações
* Operações auxiliares

> A disponibilidade dos recursos pode variar conforme o plano contratado e as permissões da conta de seu workspace.

***

#### Pré-requisitos

Antes de utilizar a collection, certifique-se de possuir:

* Credenciais de acesso válidas
* Token de autenticação ativo
* Ambiente configurado no Postman
* Permissões necessárias para execução das operações
* Templates e Flows (aprovados)

***

#### Importando a Collection

**Passo 1**

<sub>Baixe o arquivo da Collection disponibilizado pela equipe.</sub>

**Passo 2**

<sub>Abra o Postman.</sub>

**Passo 3**

<sub>Selecione a opção</sub> <sub></sub><sub>**Import**</sub><sub>.</sub>

**Passo 4**

<sub>Escolha o arquivo</sub> <sub></sub><sub>`.json`</sub> <sub></sub><sub>da Collection ou arraste-o para a janela de importação.</sub>

**Passo 5**

<sub>Após a importação, a Collection estará disponível em sua área de trabalho do Postman.</sub>

***

#### Configuração inicial

Após importar a Collection, abra a aba **Variables do Postman** e substitua os valores de exemplo:

* `token`: seu token de acesso à API Oficial.
* `sender_number`: seu número ativo cadastrado na Ótima. Exemplo: `551140019999`.
* `workspace_uuid`: UUID do seu workspace, gerado ao criar o token na plataforma.
* `recipient_number`: número do destinatário com DDI e DDD, somente números.

Templates, Flows, produtos e catálogos precisam existir na mesma conta WhatsApp Business do número remetente. Para enviar em produção, substitua também os IDs e nomes fictícios utilizados nesses exemplos.

#### Pastas disponíveis

#### 01 - Mensagens padrão

Exemplos de mensagens de texto, reação, imagem, vídeo, áudio, documento, sticker, localização e contato. Mensagens livres dependem de uma conversa iniciada pelo cliente dentro da janela de atendimento da Meta.

#### 02 - Mensagens interativas

Exemplos com botões de resposta, listas, botão para abrir URL, produto único, lista de produtos e catálogo. Produtos e catálogos precisam estar configurados e vinculados à mesma conta WhatsApp Business do remetente.

#### 03 - Templates com respostas rápidas

Exemplos de templates aprovados com botões de resposta rápida. O nome, o idioma, os componentes e a quantidade de parâmetros enviados devem corresponder exatamente ao template aprovado na Meta.

#### 04 - Templates com CTA

Exemplos de templates com chamadas para ação, cabeçalhos de mídia e URLs. Utilize somente templates aprovados na WABA e mantenha os parâmetros na mesma ordem definida durante a criação do template.

#### 05 - Templates com CTA e respostas rápidas

Exemplos que combinam chamadas para ação e botões de resposta rápida. Os índices e tipos dos botões precisam ser iguais aos componentes do template aprovado na Meta.

#### 06 - Templates com carrossel

Exemplos de templates em carrossel com cards de imagem, mídia e botões. Cada card deve respeitar a estrutura, a ordem e o formato de mídia cadastrados no template aprovado.

#### 07 - Template com URL dinâmica

Modelo oficial para enviar templates com botão de URL dinâmica. Informe apenas o trecho variável da URL no parâmetro do botão; a parte fixa é definida no template aprovado.

#### 08 - WhatsApp Flows

Listagem e exemplos de envio de WhatsApp Flows publicados ou em rascunho, por ID ou nome, usando `navigate`, `data_exchange`, dados iniciais e template com botão Flow. O Flow, a tela inicial e o endpoint de troca de dados devem estar configurados na mesma WABA do remetente.

{% hint style="danger" %}

#### Importante <a href="#boas-praticas" id="boas-praticas"></a>

* O destinatário padrão `5511999999999` é de exemplo e deve ser substituído para testes autorizados.
* Reações precisam do `message_id` real de uma mensagem recebida pelo webhook.
* Fora da janela de atendimento da Meta, utilize um template aprovado.
* Nunca compartilhe uma Collection exportada contendo token real.
  {% endhint %}

***

#### Autenticação

As requisições exige autenticação.

Configure o token de acesso nas variáveis do ambiente ou nos headers da Collection conforme orientado pela equipe responsável pela integração.

***

#### Executando Requisições

1. Selecione o ambiente desejado.
2. Verifique se todas as variáveis obrigatórias estão preenchidas.
3. Escolha a requisição que deseja testar.
4. Clique em **Send**.
5. Analise a resposta retornada pela API.

***

#### Atualizações da Collection

Novas funcionalidades e melhorias podem ser adicionadas periodicamente.

Recomenda-se manter a Collection sempre atualizada para garantir acesso aos recursos mais recentes da plataforma.

***

#### Suporte

Em caso de dúvidas sobre a utilização da Collection ou sobre o processo de integração, entre em contato com a equipe responsável pelo suporte técnico.