API REST
JSON versionné sur HTTPS pour messagerie, vérification, contacts, modèles, webhooks, usage et compte.
- Ressources versionnées
- Authentification Bearer
- Écritures idempotentes
- Erreurs structurées
Intégrez communications et authentification à vos produits avec des API claires, des événements prévisibles et une infrastructure adaptée aux charges de production critiques.
Utilisez REST pour les workflows applicatifs, SMPP 3.4 pour la connectivité SMS entreprise adaptée et des webhooks signés pour synchroniser messagerie, inbound et vérification.
Utilisez REST pour les workflows applicatifs, SMPP 3.4 lorsque le débit SMS soutenu et la connectivité télécom sont adaptés, et les webhooks pour synchroniser livraison, messages entrants et vérification.
JSON versionné sur HTTPS pour messagerie, vérification, contacts, modèles, webhooks, usage et compte.
Connectivité SMS entreprise pour charges nécessitant sessions persistantes, contrôle du débit et reçus de livraison.
Recevez événements asynchrones de livraison, inbound, vérification, compte et workflows.
Utilisez des identifiants limités par environnement et le moindre privilège.
Pannes réseau et timeouts sont normales. Idempotence, IDs stables et états explicites permettent de reprendre sans dupliquer les actions.
Ajoutez une clé unique aux écritures éligibles.
Utilisez des IDs stables pour suivre le travail entre systèmes.
Traitez un timeout comme un résultat inconnu jusqu’à résolution sûre.
Rapprochez les événements asynchrones avec vos enregistrements.
Les exemples utilisent une variable d’environnement pour la base 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"
}'
Gardez les identifiants côté serveur. N’exposez jamais les secrets dans le JavaScript public ou les dépôts.
L’application ne doit pas déduire l’état depuis une seule réponse synchrone.
La plateforme a accepté une requête valide.
Le message a progressé sur le chemin configuré.
Une confirmation de livraison a été reçue lorsque disponible.
L’opération a échoué avec une raison structurée.
Un message ou événement client est disponible.
Le workflow de vérification a réussi.
Commencez par l’interface nécessaire, puis utilisez contrats, environnements, logs, inspection webhook et visibilité d’usage.
Définitions machine pour documentation, validation et génération SDK.
Séparez identifiants, données et comportements test et production.
Suivez request IDs, états et métadonnées sans exposer l’infrastructure privée.
Inspectez tentatives, IDs, signatures et historique des retries.
Suivez activité, volume et consommation par organisation et projet.
Associez santé du service et résilience applicative.
Gardez les secrets côté serveur, vérifiez les webhooks, isolez tenants et environnements, limitez les identifiants et journalisez les actions importantes.
Stockez clés API, identifiants SMPP et secrets webhook dans une configuration protégée.
Validez les signatures avant de faire confiance aux événements.
N’accordez que les scopes, projets et environnements nécessaires.
Isolez les données organisation et projet.
Journalisez les événements administratifs et de credentials importants.
Utilisez TLS moderne et des canaux sécurisés pour les connexions persistantes.
Utilisez requêtes prévisibles, credentials limités, événements asynchrones et visibilité opérationnelle.
Pour API, SMPP, webhooks ou intégration technique, contactez support@zayloft.com.