Este artigo explica como acessar a API Botmaker v2.0. Se quiser continuar usando a API v1.0, consulte o Anexo no final deste documento.

Leitura estimada: 11 minutos

Ao entrar em Configurações>Integrações>API (https://go.botmaker.com/#/api), você pode acessar toda a documentação relacionada ao Botmaker API v2.0 clicando na guia Documentação.

No menu à esquerda da tela, você vai ver todos os Endpoints e suas respectivas seções com documentação relacionada.

Além disso, clicando no botão Exportar, à direita da tela, você poderá baixar um arquivo .json com o código da API v2.0.

Para visualizar ou gerenciar seus credenciais, clique na guia Credenciais na tela principal da API, conforme mostrado na imagem a seguir:

Nessa página, você vai ver o token de acesso, o ID secreto e a opção Atualizar token para poder integrar a API ao seu projeto.

ANEXO: API v1

Se você quiser usar a API v1.0 na tela principal da API v2.0 conforme detalhado acima, clique no botão Usar v1.0 para acessar ou revogar as credenciais de acesso correspondentes. Você também pode seguir o processo detalhado na seção Acesso, como foi feito antes da implementação da nova versão (2.0).

Acesso

Para acessar os métodos da API e suas especificações swagger (documentação da API da Botmaker: https://go.botmaker.com/apidocs/), você deve seguir os passos que permitirão obter um token de acesso:

Passo 1: acesse a página de configuração do canal.

Passo 2: selecione API Botmaker - Credenciais.

Passo 3: gere um token ou utilize aquele que já foi gerado. É particularmente importante manter o token de acesso.

Depois de gerar o Token, acesse o swagger: API

Clique no botão “Autorizar” (canto superior direito) e insira o token de acesso no segundo campo de texto, conforme mostrado abaixo. Em seguida, clique em Autorizar.

Nota: para evitar que as mensagens cheguem de forma assíncrona (ou seja, quando os horários baixados pela API não coincidem com os da plataforma), deve-se levar em consideração o seguinte:

• A data deve estar no formato ISO-8601 (por exemplo: 2021-05-21 T16:21:20.535Z). Este formato inclui o fuso horário. Neste caso, Z indica que é GMT-0.
• Ao processar um grande número de mensagens, a prioridade é dada ao envio em paralelo e não à ordem, então pode acontecer que as remessas fiquem desordenadas. Mesmo que você tenha enviado em sequência para o WhatsApp, é possível não conseguir devido a problemas imprevisíveis de conectividade.
• Caso queira garantir o envio em ordem, você pode aguardar a confirmação da entrega pelo webhook e, em seguida, enviar a próxima mensagem. Outra alternativa é espaçar as mensagens dessa conversa com uma espera para garantir que elas sejam processadas em sequência e não em paralelo.

Para obter mais detalhes sobre como usar a API Botmaker, consulte nosso artigo relacionado: Como usar a API Botmaker?

Lembre-se de visitar nossa Central de Ajuda para mais informações.

Escrito por: Equipe Botmaker

Atualizado: 18/12/2023