IKODDI est une plateforme B2B de la société KREEZUS qui permet à ses clients d’utiliser les services suivants fournies par KREEZUS :

• Recharges Crédit Mobile
• Recharges forfait Internet
• Envoie SMS en masse (SMS Marketing)
• OTP As A Service

Les environnements

Vous avez deux environnements disponibles sur IKODDI :

1. Le staging (test) :
   1. URL de l’interface d’administration : https://staging.ikoddi.com/
   2. URL de l’API : https://api.staging.ikoddi.com/
2. La PRODUCTION :
   1. URL de l’interface d’administration : https://app.ikoddi.com/
   2. URL de l’API : https://api.ikoddi.com/

Les types d’intégrations

1. Intégration directe via l’API REST
2. Utilisation des SDK Ikoddi disponibles (Nous recommandons si c’est possible dans votre cas):
   1. NodeJS : https://www.npmjs.com/package/ikoddi-client-sdk

Avant de commencer

Création de votre compte sur Ikoddi

<aside> 💡 Rendez-vous sur https://app.ikoddi.com pour créer votre compte.

</aside>

Création de votre clé API avec les droits nécessaires

<aside> 💡 La CLE API est la clé qui vous authentifiera et vous permettra de faire toutes les requêtes dont vous avez besoin. Vous pouvez en créer en allant a la section API KEY de la plateforme ou en suivant ce lien : https://app.ikoddi.com/team/api-keys

</aside>

Vous devez créer une API KEY avec les droits suivants :

Permissions de la Clé d’API pour les opérations AIRTIME

• Envoyer du airtime
• Récuperer l'historique des airtimes
• Récupérer le solde airtime
• Lire les forfaits de recharge

Permissions de la Clé d’API pour les opérations SMS

• Envoyer des sms

RECUPEREZ VOTRE ORGANIZATION_ID

<aside> 💡 L’ organization_id est l’id de votre organisation, ce qui vous identifie pour les requêtes sur l’Api Ikoddi, vous pouvez la récupérer dans la section ORGANISATION de la plateforme ou en suivant ce lien : https://app.ikoddi.com/team/details

</aside>

RECHARGEZ VOS COMPTES (SMS ou AIRTIME)

<aside> 💡 Pour recharger vos comptes pour la production ou pour le test veuillez nous contacter a l’adresse suivante : [email protected]

</aside>

<aside> ⚠️ Pour l'envoi d'un airtime donné, la transaction se fera uniquement sur les numéros correspondants à l'opérateur téléphonique, donc veuillez SVP renseigner des numéros valides !

</aside>

ETAPES D’INTEGRATION SANS LA LIBRAIRIE POUR LA PRODUCTION

• API AIRTIME (ENVOYER DU AIRTIME)

  Récupérer la liste des forfaits de crédit mobile

  • Méthode : GET

  • Nom de l’api_key a générer: Récupérer l'historique des airtimes

  • URL :

     <https://api.ikoddi.com/api/v1/groups/{organization_id}/airtimes/mobile-credit-plans>
    

  • EXEMPLE CURL

  CURL -X GET -H'x-api-key:zgzgezrgergergefzzfefaz'  <https://api.ikoddi.com/api/v1/groups/10513888/airtimes/mobile-credit-plans> | jq
  

  • Format des données de réponses

  [
   {
      "id": "cm182522i0004n9po0exd9pgl",
      "forfaitId": "11501",
      "title": "PASS-MIX - 10mn + 15SMS + 20Mo à 263 FCFA",
      "description": "Bénéficier de 10mn d'appels + 15SMS + 20Mo Vers Orange à 263 FCFA valable 1 jour",
      "amount": "263",
      "operator": "Orange",
      "bonusDays": [
        "lundi",
        "mardi",
        "mercredi",
        "jeudi",
        "vendredi",
        "samedi",
        "dimanche"
      ],
      "availableDays": [
        "lundi",
        "mardi",
        "mercredi",
        "jeudi",
        "vendredi",
        "samedi",
        "dimanche"
      ],
      "bonusFactor": null,
      "allowedAmounts": [],
      "allowedMinAmount": null,
      "bonusDescription": null,
      "isSpecial": false,
      "isAvailable": true,
      "createdAt": "2024-09-18T16:08:37.034Z",
      "updatedAt": "2024-09-18T16:08:37.034Z"
    },
    {
      "id": "cm1825251000kn9pozr3x6a1a",
      "forfaitId": "11101",
      "title": "100% de bonus sur vos recharges SAP SAP",
      "description": "Bénéficiez de 100% de bonus sur vos recharges de 125F, 525F, 1025F, 5025F, 10000F et plus.",
      "amount": "",
      "operator": "Orange",
      "bonusDays": [
        "lundi",
        "mardi",
        "mercredi",
        "jeudi",
        "vendredi",
        "samedi",
        "dimanche"
      ],
      "availableDays": [
        "lundi",
        "mardi",
        "mercredi",
        "jeudi",
        "vendredi",
        "samedi",
        "dimanche"
      ],
      "bonusFactor": 100,
      "allowedAmounts": [
        "125",
        "525",
        "1025",
        "5025"
      ],
      "allowedMinAmount": "10000",
      "bonusDescription": null,
      "isSpecial": false,
      "isAvailable": true,
      "createdAt": "2024-09-18T16:08:37.141Z",
      "updatedAt": "2025-05-10T18:40:45.369Z"
    },
    ...
  ]
  

  Souscrire a un forfait de crédit mobile

  • Méthode : POST
  • URL :

  <https://api.ikoddi.com/api/v1/groups/{organization_id}/airtimes>
  

  • Permission de l’api_key a générer: Envoyer du airtime
  • Corps de la requête (body)
  • Ref (A utiliser si vous ne récupérez pas la liste des forfaits de crédit mobile ) : La ref est l’identifiant du type de transaction en fonction de l’opérateur téléphonique, dans la liste de forfaits mobile récupéré est correspond a forfaitId
    • Pour du crédit mobile Orange la ref est : 11101
    • Pour du crédit mobile Moov la ref est : 12131
    • Pour du crédit mobile Telecel la ref est : 13160

  {
      "sentTo": ["22670707070","22670707071"],
      "amount": "1000",
      "ref":"12131"
      "countryStringCode": "BF",
      "countryNumberCode": "226",
  		"campaignName":"Recharge de mois de juillet"
   }
  

  • CURL

  curl -X POST -H 'Content-Type: application/json' -H 'x-api-key: 2pBEJGrD1ob0k7xg34zFcxOCkm4t1MJI' -d '{"sentTo":["22670707070"],"amount": "100","ref":"12131","countryStringCode": "BF","countryNumberCode": "226"}' <https://api.ikoddi.com/api/v1/groups/10452921/airtimes>
  

  • Eléments du corps de la requête

  <aside> ✅ sentTo: Les destinataires du crédit mobile

  </aside>

  <aside> ✅ amount: Le montant de crédit mobile

  </aside>

  <aside> ✅ countryStringCode: Le code pays des numéros

  </aside>

  <aside> ✅ countryNumberCode: Le code téléphonique international des numéros

  </aside>

  <aside> ✅ campaignName: Le nom que vous donner a cette transaction

  </aside>

  Récupérer  la liste des forfaits internet

  • Méthode : GET
  • URL

  <https://api.ikoddi.com/api/v1/groups/{organization_id}/airtimes/internet-plans>
  

  • Nom de l’api_key a générer: Récupérer l'historique des airtimes
  • EXEMPLE CURL

  curl -X GET -H 'Content-Type: application/json' -H 'x-api-key: [2pBEJGrD1ob0k7xg34zFcxOCkm4t1MJI](<https://api.ikoddi.com/api/v1/groups/10452921/airtimes/internet-plans\\?api_key=2pBEJGrD1ob0k7xg34zFcxOCkm4t1MJI>)' [<https://api.ikoddi.com/api/v1/groups/10452921/airtimes/internet-plans>](<https://api.ikoddi.com/api/v1/groups/10452921/airtimes/internet-plans\\?api_key=2pBEJGrD1ob0k7xg34zFcxOCkm4t1MJI>)
  

  • Format des données de réponse

  [
  
    {
  
  		"id" : "12558",
  		"title" : "4 Go ce jour",
  		"description" : "Gagner 4 Go aujourd’hui valable 30 jours",
  		"amount" : "2000",
  		"operator" : "Moov",
  		"isAvailable" :true
  
    },
    {
  
      "id" : "12559",
      "title" : "2 Go ce jour",
      "description" : "Gagner 2 Go aujourd’hui valable 30 jours",
      "amount" : "1000",
      "operator" : "Orange",
      "isAvailable" :true
  
     }
  
   ]
  

  Souscrire a un forfait internet

  • Vous devez d’abord récupérer la liste des forfaits internet afin d’avoir l’identifiant (id) et le montant (amount) du forfait nécessaire pour la requête
  • Méthode : POST
  • URL

   <http://api.ikoddi.com/api/v1/groups/{organization_id}/airtimes>
  

  • Permission de l’api_key a générer: Envoyer du airtime
  • Corps de la requête (body) :

  {
     "sentTo": ["22670707070","22670707071"],
     "ref": "14258",
     "amount": "1000",
     "countryStringCode": "BF",
     "countryNumberCode": "226",
     "campaignName":"Recharge de mois de juillet"
  }
  

  • EXEMPLE CURL

  curl -X POST -H 'Content-Type: application/json' -H 'x-api-key: [2pBEJGrD1ob0k7xg34zFcxOCkm4t1M](<https://api.ikoddi.com/api/v1/groups/10452921/airtimes\\?api_key=2pBEJGrD1ob0k7xg34zFcxOCkm4t1MJI>)' -d '{"sentTo":["22670707070","22670707071"],"ref": "14258","amount": "100","countryStringCode": "BF","countryNumberCode": "226","campaignName":"Recharge de mois de juillet"}' [<https://api.ikoddi.com/api/v1/groups/10452921/airtime>](<https://api.ikoddi.com/api/v1/groups/10452921/airtimes\\?api_key=2pBEJGrD1ob0k7xg34zFcxOCkm4t1MJI>)s
  

  • Eléments du corps de la requête

  <aside> ✅ sentTo: Les destinataires du forfait internet

  </aside>

  <aside> ✅ ref: C’est l’id du forfait internet que vous obtenez en récupérant la liste des forfaits internet

  </aside>

  <aside> ✅ amount: Le montant du forfait internet contenu dans le forfait internet que vous récupérer

  </aside>

  <aside> ✅ countryStringCode: Le code pays des numéros

  </aside>

• API SMS (ENVOYER DES SMS)

ETAPES D’INTEGRATION VIA LA LIBRAIRIE