Quem o pode usar
API base URL
Este cartão mostra o endereço da API REST. Na sua integração, usehttps://api.flowella.io/v1 como URL base, mesmo que o cartão mostre um endereço terminado em /api/v1. Consulte URL base para saber porquê.
Recent API requests
Este cartão lista os 25 pedidos de API mais recentes feitos à sua organização com chaves de API ou tokens de acesso OAuth, do mais recente para o mais antigo.
Os pedidos que o Flowella recusa antes de os executar não são listados. Incluem pedidos com um token em falta ou inválido, um âmbito em falta, um cabeçalho
API-Version não suportado ou que excedem o limite de pedidos.
Para ver tudo o que está associado a um pedido, como os eventos, tarefas e entregas de webhooks que originou, chame GET /v1/requests/{requestId} com o Request id. Requer o âmbito account:read. Consulte IDs de pedido.
API sandbox
O cartão API sandbox tem um interruptor ao nível da organização para testar sem enviar nada para o WhatsApp. A etiqueta mostra Active quando a sandbox está ativa e Off quando está desativada. Sandbox guide abre o guia da sandbox na aplicação. Para ativar a sandbox, um Owner ou Admin marca a caixa de verificação na parte inferior do cartão. Desmarque-a para desativar a sandbox. A alteração aplica-se de imediato a toda a organização. Também pode consultar e alterar a definição comGET /v1/sandbox e PATCH /v1/sandbox, usando o corpo { "enabled": true } ou { "enabled": false }. Ambos requerem o âmbito sandbox:manage.
API sandbox e chaves de sandbox
Há duas formas de usar a sandbox. A API sandbox ao nível da organização abrange todos os pedidos, enquanto uma chave de sandbox abrange apenas os pedidos feitos com essa chave.O que muda na sandbox
Quando a sandbox abrange um pedido:POST /v1/messagesguarda a mensagem na conversa e devolve"sandbox": truecommetaMessageIddefinido comonull. Nada chega ao WhatsApp e nenhum webhookmessage.senté acionado.- A submissão de modelos com
POST /v1/templates/{id}/submitnão chega à Meta. Aprova o modelo de imediato, ou rejeita-o se o nome do modelo contiverreject_. Um cabeçalho multimédia cujo exemplo seja apenas um endereço web é recusado com400 INVALID_TEMPLATE_COMPONENTS. A decisão aparece na API e no feed de eventos, mas a página Templates na aplicação não muda. - A sandbox funciona na sua organização real. Os contactos, conversas e mensagens criados durante os testes são guardados como quaisquer outros e aparecem na aplicação.
Ferramentas de teste da sandbox
Estes endpoints ajudam a simular atividade. Requerem o âmbitosandbox:manage e funcionam quer a sandbox esteja ativa ou não, por isso use-os apenas com dados de teste.
As ferramentas de teste escrevem apenas no feed de eventos (
GET /v1/events). Não enviam webhooks nem alteram a própria mensagem.
Quickstarts
O cartão Quickstarts contém ligações para guias passo a passo. Cada um abre como um ficheiro Markdown num novo separador.Links
Relacionado
Introdução à API
Autenticação, âmbitos, limites de pedidos e erros.
Chaves de API
Crie chaves reais e de sandbox.
Aplicações de programador
Registe uma aplicação OAuth e gira as aplicações instaladas.
Referência de webhooks
Tipos de eventos, payloads e verificação de assinaturas.

