Créer une session de lancement du portail client

Aperçu

Créer une session de lancement du portail client

Génère un lien hébergé à usage unique vers le portail client pour un client de votre organisation. Destiné aux applications marchandes (backend) via clé API.

Quand l’utiliser

Utilisez cet endpoint quand vous devez exécuter POST /customers/{id}/portal-launch-session (Créer une session de lancement du portail client).

Authentification

Les routes marchandes nécessitent une clé API dans l’en-tête X-API-KEY (voir Vue d’ensemble). Utilisez une clé test avec https://sandbox.api.lomi.africa et une clé live avec https://api.lomi.africa.

Endpoint

POST /customers/{id}/portal-launch-session

URLs de base :

• https://sandbox.api.lomi.africa
• https://api.lomi.africa

Requête

Paramètres d’URL

Paramètres de requête

Aucun paramètre de requête.

Corps de la requête

Corps JSON.

Schéma: object

Exemple de corps :

{
  "return_url": "string",
  "flow_type": "portal_home",
  "flow_subscription_id": "string"
}

Réponses

Erreurs

Les erreurs suivent un format JSON standard. 401 : clé manquante ou invalide. 404 : ressource introuvable. 429 : trop de requêtes. Pour les créations, envoyez une clé d’idempotence si votre flux le permet.

Exemple

curl -sS -X POST "https://sandbox.api.lomi.africa/customers/value/portal-launch-session" \
  -H "X-API-KEY: $LOMI_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"return_url":"string","flow_type":"portal_home","flow_subscription_id":"string"}'

OpenAPI

• operationId: CustomersController_createPortalLaunchSession
• Operation: POST /customers/{id}/portal-launch-session

Schémas complets et Try it : référence API.