Trung tâm nhà phát triển

Ủy quyền oAuth

POST /esignglobal/v1/oauth2/accessToken

Mô tả giao diện

Thông quaapp_idapp_secretlấy xác thựcaccess_tokenđể yêu cầu eSignGlobal API với tư cách là một người dùng cụ thể, thời gian hiệu lực của Token là 24 giờ.

Tham số yêu cầu

Tên tham số

Loại

Bắt buộc

Giải thích

client_id

string

true

Tài khoản ứng dụng, tức là app_id

Vui lòng đăng ký tài khoản eSignGlobal và tạo ứng dụng trước khi lấy.

client_secret

string

true

Mật khẩu ứng dụng, tức là app_secret

Vui lòng đăng ký tài khoản eSignGlobal và tạo ứng dụng trước khi lấy.

grant_type

string

true

Loại ủy quyền, hỗ trợ các loại sau:

client_credentials:Dựa trên client_id và client_secret để đổi lấy access_token

authorization_code:Cần người dùng tham gia vào quy trình ủy quyền (thời hạn hiệu lực là 365 ngày tự nhiên). Sau khi ủy quyền hoàn tất, có thể lấy access_token và refresh_token

refresh_token:Trong thời hạn hiệu lực của ủy quyền và khi refresh_token vẫn còn hiệu lực, có thể kéo dài thời hạn hiệu lực của refresh_token thông qua thao tác làm mới

code

string

false

Mã ủy quyền, do eSignGlobal trả về sau khi người dùng ủy quyền, bắt buộc phải truyền khi grant_type là authorization_code

refresh_token

string

false

Làm mới token, chỉ cần cung cấp mã thông báo làm mới khi grant_type là refresh_token

Tất cả các tham số phải được thông qua multipart/form-data gửi ở định dạng biểu mẫu, không thể làm tham số truy vấn URL hoặc phần thân yêu cầu JSON.

Ví dụ yêu cầu

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

Tham số phản hồi

Tên tham số

Loại

Mô tả

access_token

string

Token xác thựcĐược sử dụng để xác thực yêu cầu giao diện, thời gian hiệu lực là 1 ngày tự nhiên

expires_in

int

Thời gian còn lại trước khi Token hết hạn, đơn vị: giây

scope

string

Phạm vi quyền hạn

  • Khi grant_type là client_credentials, trả về giá trị cố định:read-write
  • Khi grant_type là authorization_code hoặc refresh_token, trả về phạm vi ủy quyền tương ứng

token_type

string

Loại Token

Giá trị cố định: bearer

refresh_token

string

Được sử dụng để làm mới token, chỉ được trả về khi grant_type là authorization_code hoặc refresh_token, thời gian hiệu lực là 30 ngày tự nhiên, cần phải ủy quyền lại sau khi hết hạn

Ví dụ phản hồi

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

 

Mô tả giao diện
Tham số yêu cầu
Ví dụ yêu cầu
Tham số phản hồi
Ví dụ phản hồi