Référence API
Authentification
En-têtes de clés API, gestion des secrets, autorisations et rotation.
Modèle d'informations d'identification
Les clés MakePay API sont créées à partir de la zone de développement MakeCrypto et limitées à une seule équipe. Chaque clé possède un identifiant de clé publique et un secret. Le secret est stocké sous forme de hachage et n'est affiché qu'une seule fois après sa création.
| En-tête | Valeur | Notes |
|---|---|---|
x-makecrypto-key-id | ID de clé API MakePay | Commence par mk_makepay_ pour les API de paiement MakePay. |
x-makecrypto-key-secret | Secret API à usage unique | Affiché uniquement lors de la création de la clé. Stockez-le dans votre gestionnaire de secrets côté serveur. |
Création de clé API
Les utilisateurs connectés disposant de l'autorisation settings.manage peuvent créer des clés via le portail ou via la voie d'intégration d'équipe.
Utilisez la route de découverte d'entreprise connectée lorsqu'un outil de portail doit afficher les équipes disponibles pour l'utilisateur actuel :
GET /api/partner/v1/companies
La société id renvoyée est utilisée uniquement pour les itinéraires de gestion des tableaux de bord/clés. Les itinéraires de paiement de serveur à serveur MakePay résolvent l'entreprise à partir de la clé API, ils ne nécessitent donc pas d'identifiant d'entreprise dans URL.
POST /api/partner/v1/companies/{companyId}/integrations
Content-Type: application/json
{
"name": "Production backend",
"appSlug": "makepay",
"allowedOrigins": ["https://merchant.example"]
}
La réponse inclut integration.key_id, integration.partner_id et integration.keySecret. Enregistrez immédiatement keySecret.
Demander une authentification
Envoyez l'ID de clé et le secret sous forme d'en-têtes aux itinéraires de lien de paiement MakePay.
x-makecrypto-key-id: mk_makepay_...
x-makecrypto-key-secret: mksec_...
Le API accepte également les sessions de navigateur MakeCrypto connectées pour les appels de l'interface utilisateur du portail. Les intégrations de serveur à serveur doivent utiliser les en-têtes de clé afin que les demandes soient indépendantes d'une session utilisateur.
Autorisations
Les itinéraires de lecture acceptent tout membre de l’équipe connecté ou une clé MakePay API valide. Les routes en mutation nécessitent settings.manage pour les sessions de navigateur. Les clés API sont traitées comme des informations d'identification de serveur de confiance pour l'équipe propriétaire, alors limitez-les aux systèmes back-end que vous contrôlez.
Rotation et révocation
Créez une nouvelle clé, déployez-la sur votre backend, puis désactivez ou supprimez l'ancienne clé dans la zone développeur MakeCrypto. Les secrets existants ne peuvent plus être révélés après la création.
Erreurs d'authentification
401 Unauthorizedsignifie que la demande n’a pas de session valide ni de paire de clés API valide.401 Invalid MakePay API credentialssignifie que l'ID de clé, le secret, la portée du produit ou l'état activé ne correspondent pas.403 Forbiddensignifie que l'utilisateur connecté ne peut pas accéder à l'équipe ou ne dispose pas de l'autorisation requise.404 API key not foundest renvoyé par les routes de gestion de clés lorsque lepartnerIdsélectionné n'existe pas pour l'équipe.