Aller au contenu principal

Familles de routes

Ikawaari expose actuellement plusieurs familles d’API déjà implémentées, plutôt qu’un espace de noms unique parfaitement uniforme.

Cette page explique comment lire correctement la surface API de la plateforme.

Pourquoi les familles de routes comptent​

Différentes capacités sont exposées à travers différents groupes de routes, selon que l’appelant est :

  • une intégration server-to-server utilisant des clés API
  • un dashboard marchand authentifié ou un client marchand
  • une checkout session ou un flux de checkout hébergé
  • une intégration spécifique à un module comme escrow, billing ou marketplace

Familles de routes cœur​

Ressources publiques ou orientées clé API​

Les exemples incluent des familles de routes telles que :

  • payment_intents
  • webhook_endpoints
  • balance
  • balance_transactions

Ces routes sont importantes pour les intégrations de paiement et les intégrations pilotées par événements.

Famille de routes marchandes​

Les capacités opérationnelles marchandes sont principalement exposées sous :

  • api/v1/merchant/*
  • api/merchant/*

Cette famille inclut le dashboard, les paiements, la balance, les payouts, le reporting, les notifications, les paramètres, la recherche et d’autres opérations marchandes.

Familles de routes checkout​

Les fonctionnalités liées au checkout sont réparties entre :

  • api/v1/checkout/sessions
  • api/checkout/*

Elles sont utilisées pour la création de session, les flux de checkout hébergé, la soumission de paiement, le polling de statut et les reçus.

Familles de routes produit et module​

Les domaines implémentés ont aussi des groupes de routes dédiés, notamment :

  • api/v1/escrow/*
  • api/v1/billing/*
  • api/v1/marketplace/*
  • api/v1/payout-engine/*
  • api/v1/funding/*

Règle de documentation​

La documentation Ikawaari doit documenter la forme API implémentée telle qu’elle existe aujourd’hui, même lorsqu’elle s’étend sur plusieurs familles de routes.

L’objectif est d’être exact d’abord, puis d’améliorer progressivement la cohérence ou la couverture de référence générée dans le temps.

Pages liées​