For the complete documentation index, see llms.txt. This page is also available as Markdown.

login

Connexion

Obtenez un token bearer marchand à l’aide des identifiants client qui vous ont été fournis.

POST /api/v1/auth/login HTTP/1.1
Host: api.example.com
Accept: application/json
Content-Type: application/json

{
  "clientKey": "8f93aa63-merchant-key",
  "clientSecret": "replace-with-your-secret"
}

Requête cURL équivalente :

curl --request POST "https://api.example.com/api/v1/auth/login" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data '{
    "clientKey": "8f93aa63-merchant-key",
    "clientSecret": "replace-with-your-secret"
  }'

Champs de la requête

Champ
Obligatoire
Type
Description

clientKey

Oui

string

Clé API marchand fournie lors de l’onboarding. Une valeur vide produit Username is required.

clientSecret

Oui

string

Secret marchand actuel. Une valeur vide produit Password can not be empty.

Réponse réussie — HTTP 200

Le modèle de connexion hérite d’un champ succeed qui n’est pas l’indicateur de réussite faisant autorité pour cet endpoint. Utilisez le statut HTTP et responseCode ; une connexion réussie renvoie HTTP 200, responseCode: "00" et un token.token non vide.

Stockez token.token en mémoire ou dans un cache de courte durée correctement protégé. Renouvelez-le en vous reconnectant avant tokenExpiry. Le token retourné est un token d’accès ; aucun refresh token n’est fourni.

Clé invalide — HTTP 401

Secret invalide — HTTP 401

Compte verrouillé — HTTP 403

Les autres échecs de connexion incluent :

  • Your account is not active. Please contact support — le compte marchand est désactivé.

  • Please contact support. Account status mismatch — la validation d’intégrité des identifiants a échoué. Ne réessayez pas ; le dossier marchand doit être vérifié.