Activer le module

Deux familles de clés. Une clé `sk_agy_*` pilote votre agence : inviter, ouvrir et suivre les dossiers de vos clients, recevoir leurs événements. Elle s'émet depuis les réglages de votre espace agence, une fois votre propre compte ouvert. Une clé `sk_user_*` lit en lecture seule les marchands qui vous ont accordé un accès.

Demander une clé sk_user_*

Profil, Réglages, section « Clés API utilisateur ». La clé porte votre identité, pas celle d'un marchand. S'ouvre dans un nouvel onglet.

Ce que le compte doit porter

1Une agence active, dont le compte est ouvert.
2Une clé sk_agy_test_* pour recetter en simulation, sk_agy_live_* pour le réel.
3Pour la vue agrégée : une clé sk_user_test_* ou sk_user_live_*, et au moins un accès marchand accordé.

Si la condition n'est pas remplie

Une clé qui n'est pas une clé d'agence répond 403 AGENCY_KEY_REQUIRED sur les endpoints agency/*. Une agence dont le compte n'est pas ouvert reçoit 409 AGENCY_ACCOUNT_NOT_OPEN à l'invitation. Sur la vue agrégée, une clé marchande répond 403 USER_KEY_REQUIRED.

Par où entrer

POSTInviter un client/api/v1/agency/clients/invitationsGETSuivre vos invitations/api/v1/agency/clients/invitationsGETLister les marchands accessibles/api/v1/user/merchants

Guides de recettes

Enrôler un client, de l'invitation au compte ouvert4 étapes

Une clé `sk_agy_*` invite vos clients, ouvre leur dossier, et suit son instruction. Voici l'ordre des appels, et comment le recetter en simulation.

Construire un tableau de bord multi-comptes5 étapes

Une clé `sk_user_*` lit plusieurs marchands à la fois, en lecture seule. Voici l'ordre des appels.

Réconcilier les virements reçus3 étapes

Rapprocher les virements de leurs paiements, sur plusieurs comptes, sans demander l'accès aux relevés.