FreeGate Docs

Clés API

Authentification par clé API et scopes.

Chaque requête à l'API FreeGate est authentifiée par une clé API. Elle part dans l'en-tête Authorization, selon le schéma Bearer.

Authorization: Bearer <VOTRE_CLE_API>

Le schéma de sécurité OpenAPI correspondant est ApiKeyBearer (type: http, scheme: bearer).

Scopes

Les clés sont scopées. Chaque endpoint exige un scope précis. Une clé sans le bon scope reçoit une réponse 403 avec le code AUTH_SCOPE_MISSING.

ScopeEndpoint
operators:readGET /v1/operators
payins:createPOST /v1/payins, POST /v1/payins/{id}/execute
payouts:createPOST /v1/payouts
transactions:readGET /v1/transactions/{id}
wallets:readGET /v1/wallets

Bonnes pratiques

  • Ne committez jamais une clé API. Ne l'exposez jamais côté client.
  • Utilisez des clés distinctes par environnement (sandbox / production).
  • Donnez à chaque clé le minimum de scopes.
  • En cas de fuite, révoquez la clé. Générez-en une nouvelle depuis la console.

Une clé manquante ou invalide renvoie 401 avec le code AUTH_API_KEY_MISSING. Voir Codes d'erreur.

Sur cette page