Pusat pembangun

Pengesahan oAuth

POST /esignglobal/v1/oauth2/accessToken

Deskripsi Antara Muka

Melaluiapp_iddanapp_secretdapatkan pengesahanaccess_token, digunakan untuk meminta eSignGlobal API dengan identiti pengguna tertentu. Tempoh sah Token adalah 24 jam.

Parameter Permintaan

Nama Parameter

Jenis

Diperlukan

Keterangan

client_id

string

true

Akaun aplikasi, iaitu app_id

Sila daftar akaun eSignGlobal dan buat aplikasi terlebih dahulu untuk mendapatkannya.

client_secret

string

true

Kata laluan aplikasi, iaitu app_secret

Sila daftar akaun eSignGlobal dan buat aplikasi terlebih dahulu untuk mendapatkannya.

grant_type

string

true

Jenis kebenaran, menyokong jenis berikut:

client_credentials:Berdasarkan client_id dan client_secret untuk mendapatkan access_token

authorization_code:Memerlukan penglibatan pengguna dalam proses kebenaran (tempoh sah selama 365 hari kalendar). Selepas kebenaran selesai, access_token dan refresh_token boleh diperolehi

refresh_token:Dalam tempoh sah kebenaran, dan jika refresh_token masih sah, tempoh sah refresh_token boleh dilanjutkan melalui operasi penyegaran

code

string

false

Kod kebenaran, dikembalikan oleh eSignGlobal selepas pengguna memberi kebenaran, wajib dihantar apabila grant_type ialah authorization_code

refresh_token

string

false

Token penyegaran, hanya perlu menyediakan token penyegaran apabila grant_type ialah refresh_token

Semua parameter mesti melalui multipart/form-data format borang, tidak boleh diserahkan sebagai parameter pertanyaan URL atau badan permintaan JSON.

Contoh Permintaan

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

Parameter Respons

Nama Parameter

Jenis

Keterangan

access_token

string

Token PengesahanDigunakan untuk pengesahan permintaan antara muka, sah untuk 1 hari kalendar

expires_in

int

Baki masa Token sebelum tamat tempoh, unit: saat

scope

string

Skop Kebenaran

  • Apabila grant_type ialah client_credentials, kembalikan nilai tetap:read-write
  • Apabila grant_type ialah authorization_code atau refresh_token, kembalikan skop kebenaran yang sepadan

token_type

string

Jenis Token

Nilai tetap: bearer

refresh_token

string

Digunakan untuk memuat semula token, hanya dikembalikan apabila grant_type ialah authorization_code atau refresh_token, sah untuk 30 hari kalendar, kebenaran perlu diberikan semula selepas tamat tempoh

Contoh Respons

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

 

Deskripsi Antara Muka
Parameter Permintaan
Contoh Permintaan
Parameter Respons
Contoh Respons