Visão geral da API

URL base

Sandbox (host público atual):

https://api.morisbox.com/api/v1

Todos os endpoints ficam sob /api/v1, salvo indicação em contrário.

AmbienteURL base
Sandboxhttps://api.morisbox.com/api/v1
Docker localhttp://127.0.0.1:11300/api/v1
Serviço do sandboxURL
Partner Hubhttps://partner.morisbox.com
Documentação para parceiroshttps://docs.morisbox.com/partners
Documentação para desenvolvedoreshttps://developers.morisbox.com/developers
Painel do desenvolvedorhttps://developers.morisbox.com/login
Application Clienthttps://morisbox.com

Convenções

TemaRegra
FormatoSolicitação JSON / resposta JSON
AutenticaçãoAuthorization: Bearer <api_key>
TelefonesE.164 (+228XXXXXXXX)
DatasStrings ISO-8601
Erros{ "error": { "code", "message" } }
Criação bem-sucedidaNormalmente 201

Duas superfícies de API

SuperfícieChavePúblicoDocumentação
Partner APIsk_…Organizações parceiraseste site (Mensagens, Bots…)
Developer APIsk_dev_…Desenvolvedores independentesdocs.morisbox.com/developers

Grupos de recursos (parceiros)

GrupoPrefixoDocumentação
Mensagens/messagesMensagens
Evidência de entrega/messages/{id}/auditSegurança e conformidade
Transmissões/broadcastsTransmissões
Modelos/templatesModelos
Contas/accountsContas e vinculação
Conversas/conversationsConversas
Bots/botsBots
Validação/validate/*Validação de campos
Configurações/settings/*Chaves, usuários, campos e conformidade

Grupos de recursos (desenvolvedores)

GrupoPrefixoDocumentação
Autenticação/auth/developer/*Desenvolvedores
Perfil / configurações/dev/me, /dev/settingsDesenvolvedores
Chaves/dev/api-keysDesenvolvedores
Modelos MorisBox/dev/templatesDesenvolvedores
Mensagens/dev/messagesDesenvolvedores

Exemplo de parceiro: listar mensagens

GET /api/v1/messages?phone=%2B228XXXXXXXX&limit=20
Authorization: Bearer sk_…

Exemplo de desenvolvedor: enviar usando um modelo

POST /api/v1/dev/messages
Authorization: Bearer sk_dev_…
Content-Type: application/json

{
  "phone": "+228XXXXXXXX",
  "template_code": "notification",
  "lang": "fr",
  "vars": { "text": "Bonjour" }
}

Limites de solicitações

Podem ser aplicados limites por chave. Em caso de throttling: 429 + indicação de nova tentativa. Prefira as transmissões para grandes volumes (parceiros).

Versionamento

Versão pública atual: v1. Alterações incompatíveis usarão um novo prefixo (/api/v2) ou um período de descontinuação documentado.