Guide de Configuration de l’API

Avant de pouvoir suivre le tutoriel de l’API Gateway, vous devez configurer votre compte, votre projet et vos clés d’API.

Comme nous n’avons pas encore d’interface graphique (Dashboard) pour les développeurs, ce guide vous montre comment tout configurer manuellement avec des requêtes curl et en vous basant sur notre Référence API.

Prérequis : Le Téléphone du Vendeur

Votre Projet (ex: “Mon site E-commerce”) doit être lié à un Device (le téléphone du Vendeur qui recevra l’argent).

Configuration de votre Compte

Étape 1 : Créer votre compte

D’abord, créez votre propre compte utilisateur.

curl -X POST 'https://api.ultimatepay.app/v1/auth/register' \
-H 'Content-Type: application/json' \
-d '{
  "username": "Toky Dev",
  "email": "[email protected]",
  "phoneNumber": "+26134XXXXXXX",
  "password": "UnMotDePasseTresSecurise"
}'

Étape 2 : Vous Connecter

Connectez-vous pour obtenir votre access_token (JWT). Vous en aurez besoin (en tant que Bearer Token) pour toutes les étapes suivantes.

curl -X POST 'https://api.ultimatepay.app/v1/auth/login' \
-H 'Content-Type: application/json' \
-d '{
  "email": "[email protected]",
  "password": "UnMotDePasseTresSecurise"
}'

Réponse (Gardez ce token !) :

{
  "access_token": "eyJhbG...SflKxw...",
  "refresh_token": "eyJhbG...adQssw...",
  "user": { ... }
}

Étape 3 : Lier votre Téléphone de Vendeur à votre Compte

Maintenant, liez le téléphone de votre Vendeur à votre compte utilisateur.

• Ouvrez l’application Ultimate Pay sur le téléphone du Vendeur.
• Allez dans les paramètres et lier à un compte.
• Entrez votre email lié à votre compte (créé à l’étape 1).

Pour savoir si le téléphone est bien lié, vous pouvez appeler cet endpoint :

# Remplacez $ACCESS_TOKEN par votre "access_token"
curl -X GET 'https://api.ultimatepay.app/v1/devices/current-user' \
-H 'Authorization: Bearer $ACCESS_TOKEN'

Elle permet de lister tous les téléphones liés à votre compte. (Elle sera utile pour recuperer le deviceId pour la liaison avec un projet).

Configuration de votre Projet

Étape 4 : Créer votre Projet

Maintenant, créez votre projet (votre site e-commerce) en utilisant votre access_token et le deviceId de votre Vendeur (obtenu au précedement).

# Remplacez $ACCESS_TOKEN par votre "access_token"
# Remplacez $DEVICE_ID par l'ID du téléphone de votre Vendeur
# websiteUrl et callbackUrl sont optionnels mais doivent être des URLs valides
 
curl -X POST 'https://api.ultimatepay.app/v1/projects' \
-H 'Authorization: Bearer $ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"name": "Mon Site E-commerce",
"description": "Boutique en ligne de t-shirts",
"websiteUrl": "https://mon-site.mg",
"callbackUrl": "https://api.mon-site.mg/webhook/ultimatepay",
"environment": "SANDBOX",
"devices": ["$DEVICE_ID"]
}'
 

Réponse (Gardez le id du projet !) :

{
  "name": "Mon Site E-commerce",
  "id": "e4a2-a945-c56a418065aa-b47b",
  ...
}

Étape 5 : Créer votre Clé d’API

Enfin, créez la clé secrète (X-PROJECT-API-KEY) que vous utiliserez pour authentifier votre serveur (pas vous, votre serveur) lors de l’initialisation des paiements.

# Remplacez $ACCESS_TOKEN par votre "access_token"
# Remplacez $PROJECT_ID par l'ID de votre projet (de l'étape 4)
 
curl -X POST 'https://api.ultimatepay.app/v1/apikeys' \
-H 'Authorization: Bearer $ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"projectId": "$PROJECT_ID",
"environment": "SANDBOX",
"secret": "ma_cle_secrete_tres_forte_12345"
}'
 

Réponse (Gardez le secret !) :

{
  "apiKey": "keyPrefix.ma_cle_secrete_tres_forte_12345",
  "keyPrefix": "pk_...",
}

Le apiKey reçue est la clé que vous utiliserez comme X-PROJECT-API-KEY dans le tutoriel.

Vous êtes prêt ! Vous avez maintenant tout ce qu’il faut pour suivre le Tutoriel de l’API Gateway.