Aller au contenu principal

Référence API

Ikawaari expose actuellement plusieurs familles de routes API déjà implémentées.

Par exemple :

  • https://api.ikawaari.com/payment_intents
  • https://api.ikawaari.com/webhook_endpoints
  • https://api.ikawaari.com/api/v1/merchant/*
  • https://api.ikawaari.com/api/v1/escrow/*
  • https://api.ikawaari.com/api/v1/billing/*
  • https://api.ikawaari.com/api/checkout/*

Commencez par Familles de routes pour comprendre comment la surface implémentée de la plateforme est organisée.

Authentification​

L’authentification dépend de la famille de routes et du type d’appelant. Les mécanismes courants incluent :

  • clés API Bearer
  • jetons JWT marchands
  • app tokens

Les exemples typiques utilisent un header Bearer token :

Authorization: Bearer ik_test_your_key_here

Format de requête​

  • Content-Type: application/json
  • Tous les montants sont exprimés dans la plus petite unité monétaire (par ex. 5000 = 5 000 XOF)
  • Les dates sont au format ISO 8601 ou en timestamps Unix

Format de réponse​

Toutes les réponses retournent du JSON. Les réponses réussies incluent directement l’objet ressource. Les erreurs suivent ce format :

{
  "error": {
    "code": "error_code",
    "message": "Description lisible par un humain",
    "type": "error_type"
  }
}

Pagination​

Le comportement de pagination dépend de la famille d’endpoints. Certaines listes utilisent un paramètre simple limit et certains endpoints marchands utilisent une pagination par page.

Exemple :

GET /payment_intents?limit=10
ParamètreDescription
limitNombre d’éléments retournés par les endpoints de liste pris en charge
pageNuméro de page pour les endpoints marchands de liste pris en charge

Idempotence​

Pour les requêtes POST, incluez un header Idempotency-Key afin de rejouer les requêtes en toute sécurité :

curl -X POST https://api.ikawaari.com/payment_intents \
  -H "Authorization: Bearer ik_test_your_key" \
  -H "Idempotency-Key: unique-request-id-123" \
  -H "Content-Type: application/json" \
  -d '{"amount": 5000, "currency": "XOF"}'

Familles de routes​

Familles de routes cœur​

Familles de routes de support​

  • API marchandes sous api/v1/merchant/*
  • API checkout sous api/v1/checkout/* et api/checkout/*
  • API des modules produit sous api/v1/escrow/*, api/v1/billing/*, api/v1/marketplace/*, et autres

Ressources​

Cœur​

Billing​

Connect​