Référence API

Une API que vous pouvez lire.

Des routes prévisibles, des identifiants préfixés, des erreurs qui disent ce qui ne va pas. Le genre d'API dont on comprend la moitié avant d'ouvrir la documentation.

Les conventions

Ce qui ne change pas d'une route à l'autre

Des identifiants préfixés

Un préfixe par type d'objet. Vous savez ce que vous manipulez sans remonter à l'appel qui l'a produit.

  • cs_ pour une session
  • plink_ pour un lien
  • inv_ pour une facture

L'idempotence

Toute opération qui déplace de l'argent accepte une clé d'idempotence. Un réseau qui coupe se rejoue sans débiter deux fois.

  • Paiements
  • Retraits
  • Reversements

Deux environnements

Test et production partagent les mêmes routes et les mêmes réponses. Seule la clé les distingue.

  • sk_test_ et sk_live_
  • Aucun code à changer

L'authentification

Une clé secrète en en-tête. Rien d'autre à négocier.

cURL

curl https://buy.api.yabetoopay.com/v1/checkout/sessions \
  -H "Authorization: Bearer sk_test_…" \
  -H "Idempotency-Key: une-cle-a-vous" \
  -H "Content-Type: application/json" \
  -d '{ … }'
  • La clé ne quitte jamais votre serveur.
  • Une clé se remplace sans coupure, avec une grâce que vous choisissez jusqu'à 72 heures.
  • Un rôle développeur lit les clés sans pouvoir les révoquer.

Ce que l'API n'est pas

  • Pas de GraphQL, pas d'abonnement temps réel : du HTTP et des webhooks.
  • Pas de pagination par curseur sur toutes les collections.
  • Pas de carte bancaire. Mobile Money uniquement, MTN et Airtel, au Congo.

Le meilleur moyen de nous juger

Lisez la référence et faites un appel. Si quelque chose vous paraît mal fichu, dites-le-nous — c'est le genre de retour qu'on applique.