Centre de développement

Autorisation oAuth

POST /esignglobal/v1/oauth2/accessToken

Description de l'interface

Parapp_idetapp_secretobtenir l'authentificationaccess_token,utilisé pour demander l'API eSignGlobal en tant qu'utilisateur spécifique. La durée de validité du jeton est de 24 heures.

Paramètres de requête

Nom du paramètre

Type

Obligatoire

Description

client_id

string

true

Compte d'application, c'est-à-dire app_id

Veuillez d'abord enregistrer un compte eSignGlobal et créer une application pour l'obtenir.

client_secret

string

true

Mot de passe de l'application, c'est-à-dire app_secret

Veuillez d'abord enregistrer un compte eSignGlobal et créer une application pour l'obtenir.

grant_type

string

true

Type d'autorisation, prend en charge les types suivants :

client_credentials:Basé sur client_id et client_secret pour échanger access_token

authorization_code:Nécessite la participation de l'utilisateur au processus d'autorisation (valable 365 jours calendaires). Une fois l'autorisation terminée, access_token et refresh_token peuvent être obtenus

refresh_token:Pendant la période de validité de l'autorisation, et si refresh_token est toujours valide, la période de validité de refresh_token peut être prolongée par une opération d'actualisation

code

string

false

Code d'autorisation, renvoyé par eSignGlobal une fois l'autorisation de l'utilisateur terminée, requis lorsque grant_type est authorization_code

refresh_token

string

false

Jeton d'actualisation, uniquement requis lorsque grant_type est refresh_token

Tous les paramètres doivent être soumis via multipart/form-data au format de formulaire, et ne peuvent pas être utilisés comme paramètres de requête URL ou corps de requête JSON.

Exemple de requête

curl --location 'http://………………/esignglobal/v1/oauth2/accessToken' \
--form 'client_id="LZn…………g89"' \
--form 'client_secret="5ugL0rM………………Yne7b"' \
--form 'grant_type="client_credentials"' \

Paramètres de réponse

Nom du paramètre

Type

Explication

access_token

string

Jeton d'authentificationUtilisé pour l'authentification des requêtes d'API, valable pendant 1 jour calendaire

expires_in

int

Temps restant avant l'expiration du jeton, en secondes

scope

string

Portée des autorisations

  • Lorsque grant_type est client_credentials, renvoie la valeur fixe :read-write
  • Lorsque grant_type est authorization_code ou refresh_token, renvoie la portée d'autorisation correspondante

token_type

string

Type de jeton

Valeur fixe : bearer

refresh_token

string

Utilisé pour actualiser le jeton, renvoyé uniquement lorsque grant_type est authorization_code ou refresh_token, valable pendant 30 jours calendaires, après quoi une nouvelle autorisation est requise

Exemple de réponse

{
    "access_token": "eyJhbGciOiJIUzI1N………………th1pMM3oYk",
    "expires_in": 86398,
    "scope": "read-write",
    "token_type": "bearer"
}

 

Description de l'interface
Paramètres de requête
Exemple de requête
Paramètres de réponse
Exemple de réponse