Aller au contenu principal

Authentification

L'API PayerScan utilise l'authentification par API Key. Chaque boutique possède sa propre clé API unique, qui doit être incluse dans chaque requête.

En-tête de requête​

Toutes les requêtes API doivent inclure l'en-tête x-api-key :

x-api-key: YOUR_API_KEY

Exemple de requête​

curl -X POST https://api.payerscan.com/payment/crypto \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{"merchant_id": "YOUR_MERCHANT_ID", "amount": 10, "callback_url": "https://your-server.com/webhook"}'

Obtenir votre API Key​

  1. Connectez-vous au Tableau de bord marchand.
  2. Accédez à la page Stores.
  3. Trouvez votre boutique dans le tableau — les colonnes API Key et Merchant ID sont affichées directement.
  4. Cliquez sur le bouton Copy pour copier. Utilisez le bouton Regenerate si vous avez besoin d'une nouvelle clé.
Avertissement de sécurité
  • Ne jamais exposer votre API Key dans le code côté client (navigateur, application mobile).
  • Effectuez uniquement les appels API depuis votre serveur backend.
  • Changez immédiatement votre API Key si vous suspectez une compromission.

Fonctionnement​

Client → Votre backend → PayerScan API
                          ↑
                     x-api-key header
  1. Votre backend reçoit une demande de paiement du client.
  2. Votre backend appelle l'API PayerScan avec l'en-tête x-api-key.
  3. PayerScan vérifie la clé API et s'assure que la boutique et le compte marchand sont actifs.
  4. Si valide, la requête est traitée et une réponse est renvoyée.

Format de réponse d'erreur​

Lorsque l'authentification échoue, l'API renvoie une réponse JSON :

{
  "status": "error",
  "message": "Invalid API key. Please check your API key and try again.",
  "error_code": "INVALID_API_KEY"
}

Codes d'erreur d'authentification​

Statut HTTPCode d'erreurDescription
401MISSING_API_KEYL'en-tête x-api-key est manquant ou vide.
401INVALID_API_KEYLa clé API est incorrecte ou n'appartient à aucune boutique active.
403ACCOUNT_INACTIVELe compte marchand a été désactivé. Contactez le support.
403STORE_INACTIVELa boutique a été désactivée. Contactez le support.
500AUTHENTICATION_FAILEDErreur interne du serveur lors de l'authentification. Réessayez plus tard.
astuce

Si vous recevez ACCOUNT_INACTIVE ou STORE_INACTIVE, veuillez contacter le support sur payerscan.com pour réactiver votre compte.