Centro de desarrolladores

Autorización oAuth

POST /esignglobal/v1/oauth2/accessToken

Descripción de la interfaz

A través deapp_idyapp_secretobtener la autenticaciónaccess_tokenpara solicitar la API de eSignGlobal como un usuario específico. El token tiene una validez de 24 horas.

Parámetros de solicitud

Nombre del parámetro

Tipo

Obligatorio

Descripción

client_id

string

true

Cuenta de la aplicación, es decir, app_id

Por favor, primero regístrese para obtener una cuenta de eSignGlobal y cree una aplicación para obtenerla.

client_secret

string

true

Contraseña de la aplicación, es decir, app_secret

Por favor, primero regístrese para obtener una cuenta de eSignGlobal y cree una aplicación para obtenerla.

grant_type

string

true

Tipo de autorización, admite los siguientes tipos:

client_credentials:Basado en client_id y client_secret para intercambiar access_token

authorization_code:Requiere que el usuario participe en el proceso de autorización (validez de 365 días naturales). Una vez autorizada, se puede obtener access_token y refresh_token

refresh_token:Dentro del período de validez de la autorización, y si refresh_token sigue siendo válido, la validez de refresh_token se puede extender mediante una operación de actualización

code

string

false

Código de autorización, devuelto por eSignGlobal una vez que el usuario ha autorizado, obligatorio cuando grant_type es authorization_code

refresh_token

string

false

Token de actualización, solo es necesario proporcionar el token de actualización cuando grant_type es refresh_token

Todos los parámetros deben enviarse a través de multipart/form-data en formato de formulario, no se pueden usar como parámetros de consulta de URL o cuerpo de solicitud JSON.

Ejemplo de solicitud

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

Parámetros de respuesta

Nombre del parámetro

Tipo

Descripción

access_token

string

Token de autenticaciónSe utiliza para la autenticación de solicitudes de interfaz, con una validez de 1 día natural

expires_in

int

Tiempo restante antes de que el token expire, en segundos

scope

string

Alcance de permisos

  • Cuando grant_type es client_credentials, devuelve el valor fijo:read-write
  • Cuando grant_type es authorization_code o refresh_token, devuelve el alcance de autorización correspondiente

token_type

string

Tipo de token

Valor fijo: bearer

refresh_token

string

Se utiliza para refrescar el token, solo se devuelve cuando grant_type es authorization_code o refresh_token, con una validez de 30 días naturales, después de la cual es necesario volver a autorizar

Ejemplo de respuesta

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

 

Descripción de la interfaz
Parámetros de solicitud
Ejemplo de solicitud
Parámetros de respuesta
Ejemplo de respuesta