Plataformas
O MorisBox é uma única API para parceiros que alcança os usuários por diversas superfícies de cliente e canais de entrega. Esta página reúne tudo o que está disponível atualmente.
Visão geral
| Camada | Descrição | Quem usa |
|---|
| Partner API | API REST (/api/v1) para mensagens, contas, modelos, bots e webhooks | Seu backend |
| Partner Hub | Console web para chaves, bots, modelos e respostas de suporte | Operadores do parceiro |
| Partner Docs | Este site: referência da API e guias de integração | Desenvolvedores |
| Aplicativo móvel | Aplicativo nativo para usuários finais em iOS / Android (Expo) | Usuários finais |
| Application Client | Aplicativo web progressivo (o mesmo produto que o aplicativo móvel) | Usuários finais |
| Tempo real | Atualizações ao vivo (caixa de entrada, chat, transmissões) | Clientes móveis / Application Client |
| Canal in-app | Entrega no aplicativo móvel / Application Client do MorisBox | Caminho principal |
| Canal WhatsApp | Fallback / alcance quando in-app não está disponível | Fallback |
| Canal SMS | Fallback final (OTP, alertas críticos) | Fallback |
Uma única chamada de envio; o MorisBox seleciona o melhor canal na ordem.
Canais de entrega
São configurados por parceiro como uma cadeia ordenada (que pode ser sobrescrita por mensagem). Ordem típica de produção:
| Ordem | Código do canal | Superfície | Uso típico |
|---|
| 1 | inapp | Aplicativo móvel + Application Client do MorisBox | Mensagens do hub, fluxos, newsletters e chat: a experiência mais completa |
| 2 | whatsapp | WhatsApp | Usuário offline / sem aplicativo; alertas adaptados aos modelos |
| 3 | sms | SMS | OTP, contas não reivindicadas e texto como último recurso |
Observações de comportamento
| Tema | Regra |
|---|
| Conta reivindicada | Preferir inapp quando o usuário tiver reivindicado o MorisBox |
| Não reivindicada | In-app costuma ser ignorado (not_claimed) → WhatsApp / SMS |
| OTP | Pode forçar SMS / WhatsApp (ainda não há uma sessão no aplicativo) |
| Timeouts | Por etapa; em caso de falha ou timeout → próximo canal |
| Lembrete offline | Após a entrega in-app, se o usuário estiver offline → WhatsApp/SMS: “nova mensagem no MorisBox” (sem corpo E2E) |
| Idempotência | A mesma idempotency_key não gera um novo fan-out duplicado |
Consulte Conceitos principais para conhecer o ciclo de vida das contas e Mensagens para os payloads de envio.
Plataformas para usuários finais
Os usuários se autenticam com telefone + OTP. Os parceiros vinculados aparecem no hub.
Móvel (iOS / Android)
| |
|---|
| Produto | Aplicativo nativo MorisBox (Expo) |
| Autenticação | OTP sem senha |
| Recursos | Hub de parceiros, mensagens independentes, mídia, newsletters HTML, CTA com link, fluxos interativos, bots, conversas de suporte, fixar / não lida e atualizações em tempo real |
| Ideal para | Experiência completa compatível offline, clientes prontos para push e consumidores em produção |
Application Client (web)
| |
|---|
| Produto | O mesmo produto para usuários finais como aplicativo web progressivo |
| Autenticação | OTP sem senha |
| Recursos | O mesmo modelo de hub do aplicativo móvel: mensagens, fluxos, bots, suporte e newsletters |
| Ideal para | Acesso imediato sem instalação pela loja; demonstrações para parceiros e usuários desktop |
O que os usuários veem (modelo do hub)
| Área | Objetivo |
|---|
| Mensagens | Itens independentes de parceiros (texto, mídia, link, HTML e cartões de fluxo): não é uma conversa |
| Formulários / bots | Fluxos interativos com várias etapas e menus de bot |
| Conversas | Conversas de suporte iniciadas pelo usuário |
A Partner API POST /messages sempre se destina ao hub, não ao chat de suporte. Mais detalhes: Interface e experiências de mensagens.
Plataformas para parceiros
Partner API
| |
|---|
| Base | https://api.morisbox.com/api/v1 (sandbox) |
| Autenticação | Authorization: Bearer <api_key> |
| Recursos | Enviar mensagens (todos os tipos de conteúdo), contas e vinculação, modelos, transmissões, conversas (agente), bots, webhooks e sandbox |
Mapa completo: Visão geral da API · Início rápido · Autenticação.
Partner Hub
| |
|---|
| Produto | Console web para operadores |
| Tarefas típicas | Chaves de API, modelos, configurações de canais, configuração de bot / fluxo, respostas de suporte, telefones de sandbox e conformidade |
| URL (sandbox) | https://partner.morisbox.com |
Painel do desenvolvedor
Documentação para parceiros
| |
|---|
| Produto | Partner Docs (docs.morisbox.com/partners) + Developer Docs (docs.morisbox.com/developers) |
| Público | Engenheiros de integração (parceiros e desenvolvedores) |
| Escopo | REST, tipos de mídia, newsletters, fluxos, bots, webhooks, desenvolvedores e sandbox |
Plataforma em tempo real
Atualizações ao vivo para clientes de usuários finais (novas mensagens do hub, eventos de conversa e entrega de transmissões).
| |
|---|
| Transporte | Socket.IO pelo edge de tempo real |
| Clientes | Aplicativo móvel + Application Client (sessões de usuário autenticadas) |
| Modelo de escala | Gateways sem estado; rooms por conta de usuário |
| Impacto para o parceiro | Você sempre envia uma única vez por REST; os clientes são atualizados ao vivo sem polling |
Não chame a camada de tempo real a partir dos backends de parceiros para envios normais: a Partner API é suficiente.
Tipos de conteúdo × plataformas
content_type | In-app (móvel / Application Client) | WhatsApp | SMS |
|---|
text | Completo | Sim (texto) | Sim (truncado) |
image | Visualizador completo | Depende do provedor | Link / ignorar |
document | Baixar / abrir | Depende do provedor | Link / ignorar |
audio | Player | Depende do provedor | Link / ignorar |
video | Player | Depende do provedor | Link / ignorar |
link | Cartão CTA | Texto + URL | URL |
html | Leitor completo de newsletter HTML | Resumo / link | Resumo / link |
flow | Interface interativa com várias etapas | Texto de convite + deep link | Texto de convite |
system | Aviso da plataforma | Raro | Raro |
A experiência mais completa é sempre in-app. Projete primeiro os payloads para in-app; mantenha um texto curto compatível com SMS para o fallback de última milha.
Plataformas interativas (fluxos e bots)
Matriz das plataformas (quem se comunica com quem)
Your systems
│ Partner API key
▼
Partner API ──────► routing (inapp → whatsapp → sms)
│ │
│ ├─► Mobile / Application Client (hub + realtime)
│ ├─► WhatsApp
│ └─► SMS
│
├─► Partner Hub (operators)
└─► Webhooks → your HTTPS endpoints
Resumo da disponibilidade
| Plataforma | Status | Observações |
|---|
| Partner REST API | Disponível | Caminho de produção para integrações |
| Partner Hub | Disponível | Operações e configuração |
| Partner Docs | Disponível | Este site |
| Aplicativo móvel | Disponível | iOS / Android via Expo |
| Application Client | Disponível | A mesma família de produtos do aplicativo móvel |
| Push em tempo real | Disponível | Caixa de entrada / chat / transmissões ao vivo |
Canal inapp | Disponível | Entrega principal |
Canal whatsapp | Disponível | Adaptador / provedor configurado por implantação |
Canal sms | Disponível | Adaptador / provedor configurado por implantação |
| Chaves de sandbox | Disponível | Testes de envio sem risco: Sandbox |
| E2EE in-app | Disponível | Conversas + payloads selados do hub: Criptografia E2E |
| Canais de e-mail / push nativo | No roteiro | Ainda não fazem parte da cadeia padrão |
A conectividade com provedores de WhatsApp e SMS depende do seu ambiente (chaves Live versus stubs locais). O comportamento da cadeia de fallback é o mesmo em todos os ambientes.
Escolher a superfície correta
| Objetivo | Usar |
|---|
| Enviar OTP / alerta crítico | Partner API → cadeia com prioridade para SMS/WA conforme a necessidade |
| Newsletter enriquecida ou mídia | content_type=html / image / video → in-app primeiro |
| Formulário com várias etapas (estilo SEED) | Convite para fluxo + runner de fluxo |
| Suporte contínuo | O usuário inicia uma conversa; o agente responde pelo Hub / API |
| Anúncio em massa | API de transmissões |
| Automatizar menus | 360Bots (runtime local ou de serviço) |
Próximos passos
