Développeurs

Une documentation développeur plus claire dès le premier jour

Base URL propre, auth header, exemples prêts, webhooks et codes d’erreur dans une expérience organisée.

cURL PHP Laravel WordPress Node Axios Python Flutter Kotlin Java C# Go Ruby

      
cURL • PHP • Laravel • Node • Axios • Python • Flutter • Kotlin • Java • C# • Go • Ruby
1Copiez la Base URL et l'Access Token

Commencez rapidement depuis la même page sans chercher dans toute la plateforme.

2Testez un OTP ou un SMS transactionnel

Choisissez le bon scénario puis lancez la première requête via cURL ou les snippets prêts.

3Connectez votre webhook

Recevez dans votre système les callbacks sent, delivered et failed avec retries et journal visible.

4Suivez l'exécution depuis le tableau de bord

Surveillez les appareils, la santé de la file et l'état des messages sans quitter la même expérience.

Démarrage rapide

Start integration through three clear tracks

  • Créez un Access Token depuis le panneau client.
  • Associez l'Android Relay et confirmez qu'il apparaît en ligne.
  • Envoyez le premier appel Send OTP ou Send SMS, puis suivez le statut et les webhooks.
Request basics
  • Base URL https://sms.yebrax.com/api
  • Auth Header Bearer YOUR_ACCESS_TOKEN
  • Content-Type application/json
  • Relay Mode auto ou manual selon votre configuration
Health & launch endpoints

Lightweight checks before go-live

Utilisez deux endpoints rapides pendant le développement ou le CI pour confirmer que le service fonctionne et que le compte est prêt pour le trafic réel.

GET /v1/healthVérification générale sans token
GET /v1/launch/readinessRetourne le rapport de préparation au lancement du compte et nécessite account.read
POST /v1/relay/app/pairAssociez l'application via un Pairing Code ou un payload QR.
Exemples de réponses
message.accepted
{
  "ok": true,
  "request_id": "req_01H...",
  "status": "queued",
  "queued_at": "2026-03-14T12:30:00Z"
}
otp.sent
{
  "ok": true,
  "otp_id": "otp_01H...",
  "status": "sent",
  "expires_in_seconds": 300
}
message.status
{
  "ok": true,
  "request_id": "req_01H...",
  "status": "delivered",
  "device_name": "Relay Device 1",
  "attempts": 1
}
Guides rapides
OpenAPI

Utilisez le fichier OpenAPI et la collection Postman pour aligner les développeurs et l'équipe opérations.

Webhook Retry

Les échecs importants doivent revenir dans votre système via des webhooks et un journal de retry clair.

Go Live

Testez health, readiness et l'association de l'application avant le premier lancement en production.

Référence des endpoints

Clear cards instead of scattered docs

API

POST /api/v1/sms/send

Envoyez un SMS transactionnel via la file d'attente avec routage d'appareil et suivi d'état.

API

POST /v1/otp/send

Envoyez un OTP avec objectif, langue et expiration claire.

API

POST /v1/otp/verify

Vérifiez le code et renvoyez clairement success/failed/expired.

API

GET /v1/messages/status

Consultez le statut du message, les tentatives et les raisons d'échec via request_id.

API

GET /v1/recipients

Consultez le répertoire des destinataires enregistrés et cherchez par nom ou numéro.

API

POST /v1/recipient-lists/queue

Mettez une liste complète en file : chaque numéro devient un élément distinct.

Événements webhook
  • message.sent Envoyé avec succès depuis Relay.
  • message.failed L'envoi a échoué avec une raison.
  • otp.verified La vérification OTP a réussi.
  • device.offline L'appareil est passé hors ligne.
Codes d’erreur

unauthorized

La clé API ou l'en-tête d'authentification est invalide.

invalid_device

L'appareil est indisponible ou invalide pour le routage.

rate_limited

Les limites d'envoi ou de sécurité ont été dépassées.

queue_blocked

L'envoi est temporairement bloqué par l'état de la file ou les politiques.

subscription_expired

L'abonnement a expiré et doit être renouvelé.

What kinds of apps fit this integration best?+

It fits login systems, stores, bookings, invoices, and operational alerts that need OTP or event-driven messaging, not mass marketing campaigns.

Do you provide examples in multiple languages?+

Yes. Ready-to-copy examples include cURL, PHP, Laravel, Node, Axios, Python, Flutter, Kotlin, Java, C#, Go, and Ruby.

Can I use it only for OTP?+

Yes. You can rely only on Send OTP and Verify OTP if your project needs verification without other messaging flows.

Does the Android device need to stay online?+

The device should preferably stay online with permissions and foreground service enabled so sending and status heartbeat continue normally.

Where should I start in practice?+

Start by creating the account, pairing the Android Relay, taking an access token, then running your first request from the ready examples before moving to webhooks and production.

After the docs

Move to pricing, create the account, or ask for quick support

Once the integration picture is clear, the next step is account setup, pricing, or a direct message to the team for a faster rollout.

WhatsApp WhatsApp