Autenticação

A API usa chaves de API enviadas no header api-key. Cada chave pertence a um tenant (sua conta) e herda os limites do seu plano.

Header de autenticação

Envie a chave em todas as requisições:

api-key: sk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Obtendo uma chave

1. Acesse o painel do OrbitSender.
2. Vá em Configurações → Chaves de API (requer um plano com api_access).
3. Clique em Gerar chave. O valor sk_live_... é exibido uma única vez — copie e guarde com segurança.

Você pode ter até 5 chaves por conta, ativá-las/desativá-las e revogá-las a qualquer momento.

Exemplo de requisição

curl https://api.orbitsender.com/api/external/ping \
  -H "api-key: sk_live_sua_chave_aqui"

Resposta:

{
  "success": true,
  "message": "Pong! Sua chave de API é válida.",
  "timestamp": "2026-06-26T14:30:45.123Z"
}

Convenções de resposta

Todas as respostas são JSON.

• Sucesso: incluem "success": true e os dados da operação.
• Erro: incluem "success": false, um error (tipo) e uma message (descrição legível). Alguns erros trazem campos extras (ex.: current/max em limites de plano, invalid_groups em validação de grupos).

{
  "success": false,
  "error": "Bad Request",
  "message": "O campo \"name\" é obrigatório no body da requisição."
}

Códigos de status