Pour accéder à toutes les fonctionnalités de ce site, vous devez activer JavaScript.
Voici les instructions pour activer JavaScript dans votre navigateur Web. Si vous n'y arrivez pas, faites-vous assister par un ami.

Documentation API

Dernière mise à jour le 19/09/2023 à 12:14

MPay met à disposition une API REST qui permet d'interagir avec le service.

Un utilisateur de test, mpay-test@ytsamy.name (avec un mot de passe identique mpay-test@ytsamy.name), est mis à votre disposition afin de pouvoir procéder à des essais avant de travailler sur vos données réelles. Vous pouvez créer, modifier, supprimer les données de cet utilisateur sans danger; elles sont recréées à l'identique quotidiennement à 05:00.

L'URL d'accès à l'API est https://mpay.ytsamy.name/api/.

Note: Afin de ne pas surcharger notre infrastructure, une limitation de débit (rate-limiting) est appliquée au nombre de requêtes par utilisateur (ceci est indiqué dans l'en-tête de la réponse du serveur). Vous pouvez nous contacter si vous avez besoin de capacités supplémentaires.

Les exemples sont donnés avec l'outil en ligne de commande cURL. À vous de les adapter à votre client/langage de programmation favori. Le format général de la commande est le suivant:

curl [options] -i URL...

Les principales options sont les suivantes:

-X, --request <command>: la méthode de la requête: POST, GET (par défaut), ...
-H, --header <header>: insère un en-tête HTTP; à réutiliser pour chaque en-tête que vous souhaitez définir. MPay utilise l'authentification basique HTTP. Ainsi, il faut ajouter à chaque requête le paramètre "-H 'Authorization: Basic xxxxxxx'" où xxxxxxx est la clé d'accès à l'API suivie d'un deux points (:), le tout encodé en base64.
-i, --include: affiche les en-têtes de la réponse HTTP
-d, --data <data>: le corps de la requête

Vous pouvez consulter le manuel (en anglais).

Afficher/Masquer tout

Gestion utilisateur

Identification

But

Cette requête permet, après vérification du mot de passe, de récupérer la clé d'accès à l'API (indispensable pour les requêtes suivantes), la date d'expiration de l'abonnement et la liste des puces SIM.

Requête:

curl -X POST -H 'Content-Type: application/json' -i https://mpay.ytsamy.name/api/user/authenticate --data '{
  "email": "mpay-test@ytsamy.name",
  "password": "mpay-test@ytsamy.name",
  "forceRecreation": true
}'

email: votre adresse mail
password: votre mot de passe
forceRecreation: facultatif, ce paramètre permet de demander la génération d'une nouvelle clé d'accès (s'il est omis, la clé existante, également disponible sur la page d'informations de votre compte vous est renvoyée).

Codes réponse HTTP

200 OK

Le corps de la réponse contient alors les données suivantes:

{
  "accessKey": "7kGDSAdKuKHs8dv9Wn9p",
  "expiry": "2018-10-09 23:59:59",
  "sims": ["4:Orange BF", "5:TELECEL", "SIM 3"]
}

accessKey: la clé d'accès, à utiliser dans les requêtes ultérieures. Cette clé n'expire pas. Vous pouvez la réutiliser aussi longtemps qu'il vous plaira.
expiry: la date d'expiration de votre abonnement. Passé cette date, vous ne pourrez plus utiliser l'API, à moins de renouveler votre abonnement.
sims: les puces SIM actuellement installées dans votre smartphone (sous réserve que vous ayiez déjà démarré le moniteur sur votre smartphone). Le chiffre indiqué avant chaque nom de puce est un identifiant, utilisé lors de la création d'un SMS ou d'un code USSD.

400 Bad Request

Erreur de paramètres

401 Unauthorized

Erreur de mot de passe

Note: la clé d'accès à l'API est constante. Elle ne change que si vous le demandez explicitement (via le paramètre "forceRecreation", ou sur le site web, à la page d'informations de votre compte). Il s'ensuit que vous avez le choix dans l'écriture de votre client: vous pouvez récupérer la clé de manière dynamique via la méthode "/user/authenticate", ou décider de l'utiliser de manière statique en la copiant directement dans votre code.

Liste des puces SIM

But

Cette requête permet de récupérer la liste des puces SIM.

Requête

curl -X GET -i https://mpay.ytsamy.name/api/user/sims

Réponse

{
  "sims": ["4:Orange BF", "5:TELECEL", "SIM 3"]
}

Les puces SIM actuellement installées dans votre smartphone (cette liste est mise à jour au moment où vous démarrez le moniteur sur votre smartphone). Le chiffre indiqué avant chaque nom de puce est un identifiant, utilisé lors de la création d'un SMS ou d'un code USSD.

Décompte des SMS restants

But

Indiquer ou connaître le nombre de SMS restants sur votre forfait.
Si vous avez activé un forfait qui vous donne droit à un certain nombre de SMS, vous pouvez l’indiquer à MPay. A chaque envoi de SMS, le compteur sera décrémenté en conséquence.

Requêtes

curl -X GET -H 'Content-Type: application/json' -i https://mpay.ytsamy.name/api/user/sms-count

curl -X POST -H 'Content-Type: application/json' -i https://mpay.ytsamy.name/api/user/sms-count --data '{
  "puceId": 1,
  "count": 10
}

Ces deux requêtes sont pratiquement identiques.
La première permet d’obtenir la valeur des compteurs de toutes les puces. Elle utilise la méthode GET et ne prend pas de paramètre.
La seconde, elle, permet d’indiquer la valeur du compteur pour une puce donnée. Elle utilise la méthode POST et prend les paramètres suivants:

puceId: l’identifiant de la puce
count: la valeur du compteur

Le décompte est uniquement à but indicatif. S’il arrive à 0, cela n’empêchera pas l’envoi des SMS. Il peut même être négatif, indiquant ainsi le nombre de SMS que vous avez envoyés au-delà de votre forfait.

Le décompte est stocké sur 2 octets (ce qui permet de prendre en compte des nombres allant de -32768 à 32767). Pour désactiver la fonctionnalité sur une puce, mettez-y la valeur minimale (-32768).

Changement de mot de passe

But

Cette requête sert à modifier un mot de passe

Requête

curl -X POST -H 'Content-Type: application/json' -i https://mpay.ytsamy.name/api/user/new-password --data '{
  "email": "mpay-test@ytsamy.name",
  "oldPassword": "mpay-test@ytsamy.name",
  "newPassword": "nouveau"
}'

Codes réponse HTTP

200 OK: La modification du mot de passe a été effectuée.
400 Bad Request: Mauvaise requête, erreur de paramètres,...
401 Forbidden: L'ancien mot de passe oldPassword est erroné.

Suivi des opérations de transfert

Liste des opérations

But

Obtenir la liste de toutes les opérations effectuées

Requête

curl -X GET -H 'Content-Type: application/json' -H 'Authorization: Basic N2tHRFNBZEt1S0hzOGR2OVduOXA6' -i https://mpay.ytsamy.name/api/paiements

Réponse

[{
  "id": 173,
  "type": "transfertReception",
  "transaction_id": "PP171213.2245.B30709",
  "amount": 100,
  "amount_debit": null,
  "statut": "Pending",
  "date": "2017-12-13 22:45:00",
  "last_modified": "2018-11-11 23:14:29",
  "reseau": "OrangeMoney",
  "original_sms": "Vous avez recu 100 FCFA du 75353535,Zia. Le solde de votre compte est de 100 FCFA Trans ID: PP171213.2245.B30709.",
  "original_sender": "75353535",
  "nom_expediteur": "Zia",
  "numero_destinataire": null,
  "nom_destinataire": null,
  "solde": 100,
  "creation_date": "2018-11-11 23:14:29",
  "callbackResult": "200"
}, {
  "id": 174,
  "type": "transfertReception",
  "transaction_id": "PP171214.0646.B30710",
  ...
  "creation_date": "2018-11-11 23:17:50",
  "callbackResult": "200"
}]

Voir la description des champs au paragraphe Détails d'une opération

Pour cette requête, comme pour toutes celles qui renvoient des enregistrements (liste, affichage, recherche de paiements, de SMS ou de codes USSD), il est possible de préciser les champs qui vous intéressent et économiser ainsi de la bande passante à l'aide du paramètre GET "fields":

curl -X GET -H 'Content-Type: application/json' -H 'Authorization: Basic N2tHRFNBZEt1S0hzOGR2OVduOXA6' -i https://mpay.ytsamy.name/api/paiements?fields=id,transaction_id,amount,statut

Le résultat devient alors:

[{
  "id": 173,
  "transaction_id": "PP171213.2245.B30709",
  "amount": 100,
  "statut": "Pending"
}, {
  "id": 174,
  "transaction_id": "PP171214.0646.B30710",
  "amount": 200,
  "statut": "Pending"
}, {
  ...
}]

Il est possible de trier les résultats avec le paramètre sort (ex: sort=date pour trier par date, sort=-date pour un tri décroissant) ou de donner des critères de sélection. Ex: PaiementSearch[xxx]=yyy avec xxx le nom du champ, et yyy la valeur qu’il doit avoir.

Des critères peuvent être donnés pour tous les champs existants (en particulier les champs id ou transaction_id). En outre les critères supplémentaires suivants sont disponibles:

PaiementSearch[debut] et PaiementSearch[fin]: permettent de limiter la recherche à une période donnée (la date est au format YYYY-mm-dd)
PaiementSearch[nom_correspondant]: permet de rechercher le nom du correspondant (que ce soit un expéditeur ou un destinataire)
PaiementSearch[numero_correspondant]: idem, mais avec le numéro (expéditeur ou destinataire)
PaiementSearch[montant]: permet de rechercher un montant, qu’il soit porté au crédit ou au débit. Il est même possible de faire précéder le montant d’un opérateur: PaiementSearch[montant]=>=500 pour avoir les débits ou crédits supérieurs ou égaux à 500F

curl -X GET -H 'Content-Type: application/json' -H 'Authorization: Basic N2tHRFNBZEt1S0hzOGR2OVduOXA6' -i https://mpay.ytsamy.name/api/paiements?sort=-date&per-page=5&PaiementSearch[debut]=2019-02-01&PaiementSearch[fin]=2021-02-22&PaiementSearch[montant]=>=300

Si le nombre d'enregistrement est important, le résultat est scindé en plusieurs pages. Les en-têtes suivants sont ajoutés à la réponse:

Link: <https://mpay.ytsamy.name/api/paiements?page=1&per-page=10>; rel=self,
      <https://mpay.ytsamy.name/api/paiements?page=2&per-page=10>; rel=next,
      <https://mpay.ytsamy.name/api/paiements?page=200&per-page=10>; rel=last
X-Pagination-Current-Page: 1
X-Pagination-Page-Count: 200
X-Pagination-Per-Page: 10
X-Pagination-Total-Count: 2000

Link: les liens vers les pages actuelle (rel=self), première (rel=first), précédente (rel=prev), suivante (rel=next) et dernière (rel=last)
X-Pagination-Current-Page: index de la page actuelle
X-Pagination-Page-Count: nombre total de pages
X-Pagination-Per-Page: nombre d'enregistrements par page
X-Pagination-Total-Count: nombre total d'enregistrements

2 paramètres supplémentaires sont disponibles pour gérer la pagination:

page: indique la page que vous souhaitez rapatrier
per-page: indique le nombre d’enregistrement que vous souhaitez sur chaque page (indiquer perpage=0 pour désactiver la pagination et rapatrier ainsi tous les résultats en une seule fois)

Détails d'une opération

But

Afficher les détails d'une opération unique à partir de son identifiant interne d'enregistrement

Requête

Affichage de l'enregistrement 174:

curl -X GET -H 'Authorization: Basic N2tHRFNBZEt1S0hzOGR2OVduOXA6' -i https://mpay.ytsamy.name/api/paiements/174

Réponse

{
  "id": 174,
  "type": "transfertReception",
  "transaction_id": "PP171214.0646.B30710",
  "amount": 200,
  "amount_debit": null,
  "statut": "Pending",
  "date": "2017-12-14 06:46:00",
  "last_modified": "2018-11-11 23:17:49",
  "reseau": "OrangeMoney",
  "original_sms": "Vous avez recu 200 FCFA du 76161616,Tao. Le solde de votre compte est de 300 FCFA Trans ID: PP171214.0646.B30710.",
  "original_sender": "76161616",
  "nom_expediteur": "Tao",
  "numero_destinataire": null,
  "nom_destinataire": null,
  "solde": 300,
  "creation_date": "2018-11-11 23:17:49",
  "callbackResult": "200"
}

id: l'identifiant de l'enregistrement
type: le type d'opération: transfertReception, transfertEnvoi, chargement,...
transaction_id: l'identifiant de la transaction chez l'opérateur
amount: le montant créditeur de la transaction
amount_debit: le montant débiteur de la transaction
statut: le statut de la transaction: Pending (en attente) ou OK (pris en compte) (voir plus bas Changement de statut d'un paiement)
date: la date de la transaction
last_modified: date de dernière modification de l'enregistrement
reseau: l'opérateur télécom (MOBICASH ou OrangeMoney)
original_sms: le SMS d'origine, tel que reçu du smartphone
original_sender: numéro de téléphone de l'expéditeur
nom_expediteur: nom de l'expéditeur
numero_destinataire: numéro de téléphone du destinataire
nom_destinataire: nom du destinataire
solde: solde de votre compte à la suite du transfert
creation_date: date de création de l'enregistrement
callbackResult: le code statut HTTP résultant de l'invocation de l'URL de rappel (200 OK, 404 Not found,...). null si l'URL de rappel n'est pas définie; si une erreur survient, ce champs contient un texte descriptif.

Recherche d'un paiement

Cette requête est dépréciée (sera prochainement supprimée). Privilégiez la requête pour la liste des opérations qui permet d’indiquer davantage de critères de recherche (y compris l’identifiant de transaction)

But

Retrouver un paiement à partir de l'identifiant de la transaction que vous indique votre utilisateur

Requête

curl -X POST -H 'Content-Type: application/json' -H 'Authorization: Basic N2tHRFNBZEt1S0hzOGR2OVduOXA6' -i https://mpay.ytsamy.name/api/paiement/search --data '{
  "transaction_id": "PP171214.0646.B30710",
  "statut": "any"
}'

transaction_id: l'identifiant de la transaction
statut: paramètre facultatif; peut prendre les valeurs "Pending" (paiement en attente, valeur par défaut), "OK" (paiement pris en compte) ou "any" (indifférent).

Réponse

{
  "id": 174,
  "type": "transfertReception",
  "transaction_id": "PP171214.0646.B30710",
  ...
  "creation_date": "2018-11-11 23:17:49",
  "callbackResult": "200"
}

Voir la description des champs au paragraphe Détails d'une opération.

Changement de statut d'un paiement

But

Une fois qu'un paiement a été pris en compte, il est bon de le noter afin d'éviter un double usage. Cela se fait en modifiant le statut du paiement.

Requête

curl -X POST -H 'Content-Type: application/json' -H 'Authorization: Basic N2tHRFNBZEt1S0hzOGR2OVduOXA6' -i https://mpay.ytsamy.name/api/paiement/statut --data '{
  "id": 173,
  "statut": "OK"
}'

id: l'identifiant de l'enregistrement à modifier
statut: le nouveau statut (Pending, OK)

Code Réponse HTTP

200 OK: La modification a été effectuée. Dans ce cas, le corps de la requête contient l'enregistrement modifié.
400 Bad request: Erreur dans les paramètres

Génération de relevés

But

Télécharge un relevés de vos opérations

Requête

curl -X POST -H 'Content-Type: application/json' -H 'Authorization: Basic N2tHRFNBZEt1S0hzOGR2OVduOXA6' -i https://mpay.ytsamy.name/api/paiement/export-excel --data '{
  "debut": "2018-04-01",
  "fin": "2018-04-30 23:59:59"
}'

debut: date et heure de début de la période au format YYYY-mm-dd HH:MM:SS. L'heure est facultative.
fin: date et heure de fin

Codes réponse HTTP

200 OK: Dans ce cas, le serveur renvoie un fichier zip à télécharger. Ce fichier contient les relevés aux formats Microsoft Excel et PDF.
400 Bad request: Erreur dans les paramètres

SMS

Liste des SMS

But

Affiche une liste de tous les SMS envoyés.

Requête

curl -X GET -H 'Content-Type: application/json' -H 'Authorization: Basic N2tHRFNBZEt1S0hzOGR2OVduOXA6' -i https://mpay.ytsamy.name/api/sms

Pour limiter les champs renvoyés, vous pouvez utiliser le paramètre GET fields:

https://mpay.ytsamy.name/api/sms?fields=id,destinataire,contenu

Réponse

Avec limitation des champs...

[{
  "id": 571,
  "destinataire": "71815140",
  "contenu": "Message de test 19:41"
}, {
  "id": 574,
  "destinataire": "71815140",
  "contenu": "Message de test 20:35"
},{
  ...
  "id": 581,
  "destinataire": "71815140",
  "contenu": "Message de test 22:27"
}]

La description des champs se trouve dans le paragraphe Affichage d'un SMS

Affichage d'un SMS

But

Affichage de l'enregistrement correspondant à un SMS à partir de l'identifiant.

Requête

Affichage de l'enregistrement 581:

curl -X GET -H 'Authorization: Basic N2tHRFNBZEt1S0hzOGR2OVduOXA6' -i https://mpay.ytsamy.name/api/sms/581

Réponse

{
  "id": 581,
  "destinataire": "71815140",
  "contenu": "Message de test 22:27",
  "puceId": 1,
  "puce": "ONATEL",
  "creation_date": "2018-10-13 22:27:17",
  "modification_date": "2018-10-13 22:27:30",
  "statut": 5,
  "numberOfParts":3,
  "sentParts":"1, 2, 3",
  "deliveredParts":"1",
  "erreur": null
}

id: identifiant de l'enregistrement
destinataire: numéro de téléphone destinataire du SMS
contenu: texte du SMS
puceId: l'identifiant de la puce
puce: nom de la puce (l'opérateur)
creation_date: date de création de l'enregistrement
modification_date: date de modification de l'enregistrement
statut: code statut de l'enregistrement. Le code statut évolue dans le temps en fonction de l'état d'avancement de l'envoi: 1 -> Erreur, 2 -> Créé (et en cours d'acheminement), 3 -> Accepté (pour notification), 4 -> Notifié (au smartphone), 5 -> Envoyé (par le smartphone au destinataire), 6 -> Transmis (au destinataire, et le smartphone a reçu l'accusé de réception).
Note: chaque évolution du statut sous-entend une connexion à l'API, à prendre en compte si vous envoyez beaucoup de SMS, compte tenu de la limitation appliquée aux connexions (rate-limiting).
numberOfParts: le nombre de parties du SMS; le protocole de transmission des SMS prévoit la fragmentation en plusieurs parties d’un SMS long. Ici, le SMS a été fragmenté en 3 parties.
sentParts: les parties envoyées (ici, les 3 parties ont été envoyées). Le statut du SMS ne passe à 5 (Envoyé) que si toutes les parties ont été envoyées.
deliveredParts: les parties transmises (l’accusé de réception a été reçu). Ici, seulement la première partie a été transmise. Le statut du SMS ne passe à 6 (Transmis) que si toutes les parties ont été transmises
erreur: Libellé de l'erreur (uniquement si le statut est 1: Erreur, null sinon). Le libellé de l'erreur reprend le dernier statut avant la survenue de l'erreur, ce qui permet de déterminer à quel moment la chaîne de transmission a été rompue.
Note: il n'y a qu'une seul tentative. En cas d'erreur, le SMS est purement et simplement abandonné, afin d'éviter l'accumulation de SMS en attente.

Création d'un SMS

But

Création d'un SMS pour envoi à un numéro donné

Requête

curl -X POST -H 'Content-Type: application/json' -H 'Authorization: Basic N2tHRFNBZEt1S0hzOGR2OVduOXA6 ' -i https://mpay.ytsamy.name/api/sms --data '{
  "destinataire": "71815140",
  "puceId": "1",
  "contenu": "Message de test 22:01"
}'

destinataire: numéro de téléphone destinataire du SMS
puceId: identifiant de la puce utilisée pour faire l'envoi
contenu: texte du SMS à envoyer

Codes réponse HTTP

201 Created: Le SMS a été créé et est en cours d'acheminement.
400 Bad request: Erreur de paramètres

Note: d'autres codes HTTP peuvent apparaitre, en fonction de la situation.

Dans la réponse du serveur, l'en-tête Location indique l'URL à laquelle on peut consulter l'enregistrement:

Location: /sms/598

ce qui signifie:

https://mpay.ytsamy.name/api/sms/598

Un autre en-tête intéressant est Sms-Count

Sms-Count: 10

Si vous avez activé un forfait vous donnant droit à un certain nombre de SMS, vous avez la possibilité de l’indiquer à MPay. Ainsi, à chaque SMS envoyé, le compteur sera décrémenté. Ici, il reste 10 SMS pour la puce sélectionnée pour l'envoi.
Attention: il s’agit de la valeur au moment de la soumission de la requête, mais avant envoi effectif par le smartphone, ce qui veut dire par exemple que si le SMS que vous venez de soumettre est fragmenté en 2 parties pour envoi, le compteur de la puce 1 (celle qui est utilisée pour envoyer le SMS) passera de 10 à 8.
Pour activer cette fonctionnalité de décompte des SMS restants, rendez-vous à au paragraphe décompte des SMS restants.

Codes USSD

Liste des codes USSD envoyés

But

Affiche une liste de tous les codes USSD envoyés au smartphone.

Requête

curl -X GET -H 'Authorization: Basic X2d4VGhMb01HanZGY0gxVTFzREU6' -i https://mpay.ytsamy.name/api/ussdcodes

Pour limiter les champs renvoyés, vous pouvez utiliser le paramètre GET fields:

https://mpay.ytsamy.name/api/ussdcodes?fields=id,code,puce

Réponse

Avec limitation des champs...

[{
  "id":21,
  "code":"*200*3*1*1*1*1*1#",
  "puce":"ONATEL"
},{
  "id":22,
  "code":"*110#",
  "puce":"TELECEL"
},{
  "id":23,
  "code":"*144*9*1*1234#",
  "puce":"Orange BF"
},{
  ...
  "id":27,
  "code":"*110#",
  "puce":"T-Mobile"
}]

La description des champs se trouve dans le paragraphe Affichage d'un code USSD

Affichage d'un code USSD

But

Affichage de l'enregistrement correspondant à un code USSD à partir de l'identifiant.

Requête

Affichage de l'enregistrement 23:

curl -X GET -H 'Authorization: Basic N2tHRFNBZEt1S0hzOGR2OVduOXA6' -i https://mpay.ytsamy.name/api/ussdcodes/23

Réponse

{
  "id":23,
  "code":"*144*9*1#,1234",
  "statut":5,
  "response":"Votre solde disponible est ... FCFA,Compte Retrait Gratuit ... FCFA Trans ID: ....",
  "creation_date":"2019-08-14 00:52:01",
  "modification_date":"2019-08-14 00:52:01",
  "puce":"Orange BF",
  "puceId":3
}

id: identifiant de l'enregistrement
code: le code USSD à exécuter (ex: *200*3*1*1*1*1*1# pour souscrire à un forfait 10Mo auprès de l'ONATEL).
statut: le code statut de l'enregistrement; ce code statut évolue dans le temps en fonction de l'état d'évolution de la demande: 1 -> Erreur, 2 -> Créé (et en cours d'acheminement), 3 -> Accepté (pour notification), 4 -> Notifié (au smartphone), 5 -> Exécuté (par le smartphone)
Note: comme pour les SMS, chaque évolution du statut sous-entend une connexion à l'API, à prendre en compte si vous envoyez beaucoup de SMS, compte tenu de la limitation appliquée aux connexions (rate-limiting).
response: La réponse de l'opérateur Télécom à votre requête USSD ("souscription réussie", "votre solde est de ...", etc). Si le statut est 1 (Erreur), response contient le libellé de l'erreur. Ce libellé reprend le dernier statut avant la survenue de l'erreur, ce qui permet de déterminer à quel moment la chaîne de transmission a été rompue.
Note: comme pour les SMS, il n'y a qu'une seul tentative. En cas d'erreur, le code USSD est purement et simplement abandonné, afin d'éviter l'accumulation (suivie de l'exécution innopinée) de codes USSD en attente.
creation_date: date de création de l'enregistrement
modification_date: date de modification de l'enregistrement
puce: le libellé de la puce employée pour l'exécution du code USSD.
puceId: l'identifiant de la puce employée pour l'exécution du code USSD.

Création d'un code USSD

But

Création et envoi d'un code USSD pour exécution par le smartphone

Requête

curl -X POST -H 'Content-Type: application/json' -H 'Authorization: Basic N2tHRFNBZEt1S0hzOGR2OVduOXA6 ' -i https://mpay.ytsamy.name/api/ussdcodes --data '{
  "puceId": "4",
  "code": "*200*3*1*1*1*1*1#"
}'

puceId: identifiant de la puce sur laquelle exécuter le code USSD
code: le code USSD à exécuter
Note: si le code USSD doit être entré en 2 fois (pour répondre à une demande de PIN), mettez le # à la fin de la première partie, suivi d'une virgule, et de votre code PIN (ex: *144*9*1#,1234 pour le solde de votre compte Orange Money).

Codes réponse HTTP

201 Created: Le code USSD a été créé et est en cours d'acheminement.
400 Bad request: Erreur de paramètres

La réponse du serveur contient, entre autres, l'en-tête Location indiquant l'URL à laquelle on peut consulter l'enregistrement:

Location: /ussdcodes/598

ce qui signifie:

https://mpay.ytsamy.name/api/ussdcodes/598

Note: d'autres codes HTTP peuvent apparaitre, en fonction de la situation

Ping

Envoyer un ping à l'application mobile

But

Envoie un signal (un ping) à l'application mobile pour vérifier qu'elle tourne effectivement (auquel cas elle répondra par un pong). Au passage, on récupère des informations utiles sur l’état du téléphone.

Requête

curl -X POST -H 'Authorization: Basic X2d4VGhMb01HanZGY0gxVTFzREU6' -i https://mpay.ytsamy.name/api/ping

Réponse

{
  "id": 1,
  "userId": 3,
  "ping_date": "2023-09-19 10:15:19",
  "pong_date": null,
  "status": 3,
  "erreur": null,
  "batteryLevel": null,
  "batteryStatus": null,
  "batteryPlug": null,
  "gsmLevels": null
}

La description des champs se trouve dans le paragraphe Affichage des informations d'un ping

Affichage des informations d'un ping

But

Affiche toutes les informations sur le ping en cours

Requête

curl -X GET -H 'Authorization: Basic X2d4VGhMb01HanZGY0gxVTFzREU6' -i https://mpay.ytsamy.name/api/ping/view

Réponse

{
  "id": 1,
  "userId": 3,
  "ping_date": "2023-09-19 10:15:19",
  "pong_date": "2023-09-19 10:19:31",
  "status": 4,
  "erreur": null,
  "batteryLevel": 100,
  "batteryStatus": "FULL",
  "batteryPlug": "USB",
  "gsmLevels": "0, 4"
}

id: identifiant de l'enregistrement
userId: identifiant de l'utilisateur
ping_date: date d'envoi du ping
pong_date: date de réception de la réponse (pong) de l'application mobile, null si aucune réponse n'a (encore) été reçue
status: le code statut de l'enregistrement; ce code statut évolue dans le temps en fonction de l'état d'évolution du ping: 1 -> Erreur, 2 -> Créé (et en cours d'acheminement), 3 -> Accepté (pour notification), 4 -> OK, le ping a été notifié au smartphone qui a répondu par un pong (le champs pong_date indique alors la date de la réponse)
Note: le pong de l'application mobile qui entraine le passage du statut 3 au statut 4 se fait par une connexion à l'API, à prendre en compte au vu de la limitation de débit appliquée aux connexions (rate-limiting).
erreur: un éventuel message d'erreur.
batteryLevel: niveau de charge de la batterie.
batteryStatus: état de la batterie: CHARGING, DISCHARGING, FULL, NOT_CHARGING, UNKNOWN.
batteryPlug: mode de branchement de la batterie : UNPLUGGED, AC, DOCK, USB, WIRELESS.
gsmLevels: qualité de la réception GSM (0 -> NONE, 1 -> POOR, 2 -> MODERATE, 3 -> GOOD, 4 -> GREAT). Si le téléphone a plusieurs puces installées, les niveaux de toutes les puces sont indiqués les uns après les autres, séparés par des virgules.

Afficher/Masquer tout