Центр разработчиков

Авторизация OAuth

POST /esignglobal/v1/oauth2/accessToken

Описание интерфейса

Черезapp_idиapp_secretПолучить аутентификациюaccess_token,используется для запроса eSignGlobal API от имени конкретного пользователя. Срок действия токена составляет 24 часа.

Параметры запроса

Название параметра

Тип

Обязательно

Описание

client_id

string

true

Учетная запись приложения, то есть app_id

Пожалуйста, сначала зарегистрируйте учетную запись eSignGlobal и создайте приложение, чтобы получить ее.

client_secret

string

true

Пароль приложения, то есть app_secret

Пожалуйста, сначала зарегистрируйте учетную запись eSignGlobal и создайте приложение, чтобы получить ее.

grant_type

string

true

Тип авторизации, поддерживает следующие типы:

client_credentials:На основе client_id и client_secret получить access_token

authorization_code:Требуется участие пользователя в процессе авторизации (срок действия 365 календарных дней). После авторизации можно получить access_token и refresh_token

refresh_token:В течение срока действия авторизации и при условии, что refresh_token все еще действителен, можно продлить срок действия refresh_token путем обновления

code

string

false

Код авторизации, возвращается eSignGlobal после авторизации пользователя, обязателен при grant_type равном authorization_code

refresh_token

string

false

Токен обновления, требуется только в том случае, если grant_type равен refresh_token

Все параметры должны быть переданы через multipart/form-data в формате формы, а не в качестве параметров запроса URL или тела запроса JSON.

Пример запроса

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

Параметры ответа

Название параметра

Тип

Описание

access_token

string

Токен аутентификацииИспользуется для аутентификации запросов API, срок действия - 1 календарный день

expires_in

int

Время, оставшееся до истечения срока действия токена, в секундах

scope

string

Область разрешений

  • Когда grant_type имеет значение client_credentials, возвращается фиксированное значение:read-write
  • Когда grant_type имеет значение authorization_code или refresh_token, возвращается соответствующая область авторизации

token_type

string

Тип токена

Фиксированное значение: bearer

refresh_token

string

Используется для обновления токена, возвращается только когда grant_type имеет значение authorization_code или refresh_token, срок действия - 30 календарных дней, после истечения срока действия необходимо повторно авторизоваться

Пример ответа

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

 

Описание интерфейса
Параметры запроса
Пример запроса
Параметры ответа
Пример ответа