REST APIs
JSON versionado sobre HTTPS para mensagens, verificação, contatos, templates, webhooks, uso e conta.
- Recursos versionados
- Autenticação Bearer
- Escritas idempotentes
- Erros estruturados
Integre comunicações e autenticação aos seus produtos com APIs claras, eventos previsíveis e infraestrutura para cargas de produção críticas.
Use REST para workflows de aplicação, SMPP 3.4 para conectividade SMS empresarial adequada e webhooks assinados para sincronizar mensagens, inbound e verificação.
Use REST para workflows de aplicação, SMPP 3.4 quando throughput SMS sustentado e conectividade telecom forem adequados, e webhooks para sincronizar entrega, entrada e verificação.
JSON versionado sobre HTTPS para mensagens, verificação, contatos, templates, webhooks, uso e conta.
Conectividade SMS empresarial para cargas com sessões persistentes, controle de throughput e DLRs.
Receba eventos assíncronos de entrega, entrada, verificação, conta e workflow.
Use credenciais por ambiente e menor privilégio.
Falhas de rede e timeouts são normais. Idempotência, IDs estáveis e estados explícitos permitem recuperação sem duplicar ações.
Anexe uma chave única a escritas elegíveis.
Use IDs estáveis para rastrear trabalho entre sistemas.
Trate timeout como resultado desconhecido até resolver o estado.
Relacione eventos assíncronos aos seus registros.
Os exemplos usam uma variável de ambiente para a base da API.
curl "$ZAYLOFT_API_BASE/v1/messages" \
-H "Authorization: Bearer $ZAYLOFT_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: 8f36c1f0-8e7d-4d9d-a342-7aef0c2d45c2" \
-d '{
"channel": "sms",
"to": "+14155550123",
"message": "Your verification code is 482731"
}'
Mantenha credenciais no servidor. Nunca exponha segredos em JavaScript público, repositórios ou apps cliente.
O aplicativo não deve inferir estado a partir de uma única resposta síncrona.
A plataforma aceitou uma requisição válida.
A mensagem avançou pela rota configurada.
Uma confirmação de entrega foi recebida quando disponível.
A operação falhou com uma razão estruturada.
Uma mensagem ou evento do cliente está disponível.
O workflow de verificação foi concluído.
Comece com a interface necessária e avance para contratos, ambientes, logs, inspeção de webhooks e visibilidade de uso.
Definições legíveis por máquina para documentação, validação e SDKs.
Separe credenciais, dados e comportamento de teste e produção.
Rastreie request IDs, estados e metadados sem expor infraestrutura privada.
Revise tentativas, IDs, assinaturas e histórico de retries.
Acompanhe atividade, volume e consumo por organização e projeto.
Combine saúde do serviço com padrões de resiliência.
Mantenha segredos no servidor, verifique webhooks, isole tenants e ambientes, limite credenciais e registre ações importantes.
Armazene chaves API, credenciais SMPP e segredos webhook em configuração protegida.
Valide assinaturas antes de confiar nos eventos.
Conceda apenas scopes, projetos e ambientes necessários.
Isole dados de organização e projeto.
Registre eventos administrativos e de credenciais importantes.
Use TLS moderno e canais seguros para conexões persistentes.
Use requisições previsíveis, credenciais com escopo, eventos assíncronos e visibilidade operacional.
Para API, SMPP, webhooks ou integração técnica, contate support@zayloft.com.