Documentation API

Dernière mise à jour le 12/04/2019 à 18:18

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 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] [URL...]

Les principales options sont les suivantes:

-X, --request <command>
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ée 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

Identification

Changement de mot de passe

Liste des opérations

Détails d'une opération

Recherche d'un paiement

Changement de statut d'un paiement

Génération de relevés

Liste des SMS

Affichage d'un SMS

Création d'un SMS

Afficher/Masquer tout