Definição
Uma API REST é uma interface web que expõe recursos, como mensagens, contatos ou modelos, em URLs e permite que programas os criem, leiam, atualizem e excluam usando métodos HTTP padrão (POST, GET, PATCH, DELETE), geralmente trocando dados em JSON.
REST (representational state transfer, ou transferência de estado representacional) é um estilo de arquitetura descrito por Roy Fielding em 2000. Na prática, uma API REST de mensagens significa enviar uma requisição HTTPS autenticada, por exemplo POST /messages com um corpo JSON, e receber uma resposta JSON com um ID e um status. Os códigos de status HTTP indicam o resultado: 2xx para sucesso, 4xx para erros do cliente, como números inválidos ou falta de autorização, e 5xx para erros do servidor.
Padrões comuns: autenticação por bearer token no cabeçalho Authorization, chaves de idempotência para que novas tentativas não gerem envios duplicados, paginação em listagens, limites de taxa com cabeçalhos retry-after e webhooks para resultados assíncronos, como relatórios de entrega.
O REST atende à maioria das integrações: CRMs, plataformas de e-commerce e sistemas de back-office. Para SMS em volume muito alto, operadoras e agregadores costumam usar SMPP, que mantém uma conexão persistente aberta.
Uma especificação OpenAPI descreve os endpoints em formato legível por máquina, permitindo gerar SDKs de cliente, documentação e testes a partir dela.
A OmniChannels.ai oferece uma API REST/JSON em https://api.broadnet.me com autenticação por bearer token, especificação OpenAPI 3.1 e um SDK em TypeScript.
Exemplo
POST https://api.broadnet.me/… com o cabeçalho "Authorization: Bearer <token>" e um corpo JSON; a resposta retorna um ID de mensagem.