section-9134a21

API-AIRTIME

section-1
1 Portée

AIRTIME est un proxy/API pour envoyer des SMS de confirmationet faire la facturation à des numéros abonnés à votre service, en utilisant une interface API.
AIRTIME propose deux interfaces :
- via Web: l'utilisateur se connecte via un navigateur
- via API: l'application du client échange des informations automatiquement avec la plateforme de LAfricaMobile
Ce document décrit la seconde manière et explique comment utiliser cette API.

section-2
2 Paramètres du compte
2.1 Pré-­­requis

Pour utiliser cette API, vous avez besoin d'un compte valide. Lors de la création de votre compte, LAfricaMobile doit vous donner:
- un login (nommé aussi accountid)
- un mot de passe
- un montant
- un telephone
- un opérateur
- callback
Cette paire identifiant / mot de passe est utilisée comme paramètre d’identification dans l'API.

2.2 Variables utilisées dans la documentation

Dans ce document, nous utilisons des valeurs ci-dessous. Les vraies valeurs vous seront données par notre équipe technique ou par votre propre configuration (pour les paramètres dépendant de votre côté, ret_url par exemple). Certaines d’entre elles peuvent ne pas être utilisées en fonction de vos besoins.
Valeursd’essai du document:
- login=fred
- password=xpasswordx
- montant=100
- telephone = 221773758085
- operateur = ORANGESN
- callback = https://votreentreprise.com/reception
- AIRTIME Server url : https://mtpremium-prod.lafricamobile.com

Vous devez remplacer ces valeurs par vos propres paramètres pendant vos tests.

section-3
3 Envoyer Crédit
3.1 Comment envoyer via http

Au lieu d'avoir tous les paramètres encapsulés, vous pouvez directement effectué un GET paramètres individuellement :

Les paramètres sont :

Nom Mandatory Valeur test Comment
login Y fred Value given by LAM
password Y xpasswordx Value given by LAM
montant Y 100 Montant à envoyer
operateur Y ORANGESN Code opérateur
telephone Y 221773758085 Numéro téléphone de l’utilisateur
callback N https://votreentreprise.com/reception l’url d’accusé de réception

Donc, vous pouvez faire un appel directement dans votre navigateur:
https://airtime.lafricamobile.com/airtime?login=fred&password=
xpasswordx&operateur=ORANGESN&montant=100&telephone=221773758085&callback=https://votreentreprise.com/reception

3.2 Comment envoyer via un code PHP

Voici un exemple avec le script PHP

REPONSE OK

Content-Type: application/json

{"service_id":"AIRTIMEORANGE","gu_transaction_id":"1585825004905","s
tatus":"PENDING","transaction_date":"2020/04/02 10:56:44
AM","recipient_phone_number":"773758085","amount":100,"partner_transact
ion_id":"5e85c4eca79c6"}

section-4
4 Accusé de réception en temps réel

Dans ce cas, notre serveur appelle un url lorqu’il détécte que son statut à changer.
Cet url doit être fourni dans le paramètre nommé callback

Ce callback est appelé avec ces paramètres dans une requête HTTP JSON

{"service_id":"AIRTIMEORANGE","gu_transaction_id":"1585825004905",
"status":"SUCCESSFUL|FAILED","partner_transaction_id":"5e85c4eca79c6",
callback="https://votreentreprise.com/reception"}

LAfricaMobile est la 1ère plateforme de communication multi-opérateurs et multicanale en Afrique. Nous proposons aux entreprises et organisations présentes sur le continent africain des solutions Business et Management leur permettant de créer et maintenir le lien avec leurs clients ou utilisateurs.
  • LAfricaMobile
    Siège social: Immeuble CFI ,
    11 Rue VINCENS X, Avenue Faidherbe, Dakar

  • (+221) 33 842 58 55

  • contact@lafricamobile.com