Pusat Pengembang

Otorisasi OAuth

POST /esignglobal/v1/oauth2/accessToken

Deskripsi Antarmuka

Melaluiapp_iddanapp_secretdapatkan otentikasiaccess_token,digunakan untuk meminta eSignGlobal API sebagai identitas pengguna tertentu, durasi Token yang valid adalah 24 jam.

Parameter Permintaan

Nama Parameter

Jenis

Wajib Diisi

Keterangan

client_id

string

true

Akun aplikasi, yaitu app_id

Silakan daftarkan akun eSignGlobal dan buat aplikasi terlebih dahulu untuk mendapatkannya.

client_secret

string

true

Kata sandi aplikasi, yaitu app_secret

Silakan daftarkan akun eSignGlobal dan buat aplikasi terlebih dahulu untuk mendapatkannya.

grant_type

string

true

Jenis otorisasi, mendukung jenis berikut:

client_credentials:Berdasarkan client_id dan client_secret untuk mendapatkan access_token

authorization_code:Memerlukan partisipasi pengguna dalam proses otorisasi (masa berlaku 365 hari kalender). Setelah otorisasi selesai, access_token dan refresh_token dapat diperoleh

refresh_token:Dalam masa berlaku otorisasi, dan jika refresh_token masih berlaku, masa berlaku refresh_token dapat diperpanjang melalui operasi penyegaran

code

string

false

Kode otorisasi, dikembalikan oleh eSignGlobal setelah otorisasi pengguna selesai, wajib diisi ketika grant_type adalah authorization_code

refresh_token

string

false

Token penyegaran, hanya perlu menyediakan token penyegaran ketika grant_type adalah refresh_token

Semua parameter harus melalui multipart/form-data format formulir, tidak dapat digunakan sebagai parameter kueri 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

Deskripsi

access_token

string

Token AutentikasiDigunakan untuk autentikasi permintaan antarmuka, berlaku selama 1 hari kalender

expires_in

int

Sisa waktu Token hingga kedaluwarsa, satuan: detik

scope

string

Cakupan Izin

  • Ketika grant_type adalah client_credentials, kembalikan nilai tetap:read-write
  • Ketika grant_type adalah authorization_code atau refresh_token, kembalikan cakupan otorisasi yang sesuai

token_type

string

Jenis Token

Nilai tetap: bearer

refresh_token

string

Digunakan untuk memperbarui token, hanya dikembalikan ketika grant_type adalah authorization_code atau refresh_token, berlaku selama 30 hari kalender, setelah kedaluwarsa, otorisasi ulang diperlukan

Contoh Respons

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

 

Deskripsi Antarmuka
Parameter Permintaan
Contoh Permintaan
Parameter Respons
Contoh Respons