Visão geral da API
API externa do OrbitSender para integrações de terceiros.
A API externa do OrbitSender permite que sistemas de terceiros automatizem o que normalmente é feito pelo painel: criar e conectar canais de WhatsApp, montar segmentos, disparar campanhas (mensagem, enquete e carrossel), ajustar configurações e receber eventos por webhook.
Pré-requisito
O acesso à API depende do seu plano (recurso api_access) e de uma chave de
API (sk_live_...). Veja Autenticação.
Base URL
https://api.orbitsender.comTodos os endpoints ficam sob o prefixo /api/external/.
O que dá para fazer
Canais
Criar, conectar (QR Code), listar, editar e remover canais de WhatsApp.
Segmentos
Listar grupos, criar segmentos e configurar monitoramento de grupos.
Campanhas
Disparar campanhas de mensagem, enquete e carrossel, e consultar status.
Webhooks
Receber eventos de status de campanha, progresso e status de canal.
Endpoints em Fase 2 (respondem 501)
Alguns endpoints já aparecem na referência mas ainda não estão
implementados — respondem HTTP 501: as operações de Integrações
(list/create/edit-integrations) e a edição/remoção de monitoramento de
grupo (PUT /edit-monitoring/group, DELETE /remove-monitoring/group). A
criação de monitoramento (POST /monitoring/group) já funciona.
Primeiros passos
Gere sua chave de API
No painel do OrbitSender, crie uma chave sk_live_.... Guarde-a com segurança —
ela é exibida só uma vez.
Valide a chave
Faça uma chamada ao endpoint de ping para confirmar que está tudo certo:
curl https://api.orbitsender.com/api/external/ping \
-H "x-api-key: sk_live_sua_chave_aqui"Explore a referência
Cada endpoint tem sua página com parâmetros, exemplos e um playground. Comece por Autenticação.