开发者中心

Autorizzazione oAuth

POST /esignglobal/v1/oauth2/accessToken

Descrizione dell'interfaccia

Tramiteapp_ideapp_secretottieni l'autenticazioneaccess_tokenper richiedere l'API eSignGlobal con l'identità di un utente specifico. La durata di validità del token è di 24 ore.

Parametri di richiesta

Nome parametro

Tipo

Obbligatorio

Descrizione

client_id

string

true

Account dell'applicazione, ovvero app_id

Si prega di registrarsi prima per un account eSignGlobal e creare un'applicazione per ottenerlo.

client_secret

string

true

Password dell'applicazione, ovvero app_secret

Si prega di registrarsi prima per un account eSignGlobal e creare un'applicazione per ottenerlo.

grant_type

string

true

Tipo di autorizzazione, supporta i seguenti tipi:

client_credentials:Basato su client_id e client_secret per ottenere access_token

authorization_code:Richiede la partecipazione dell'utente al processo di autorizzazione (valido per 365 giorni naturali). Una volta completata l'autorizzazione, è possibile ottenere access_token e refresh_token

refresh_token:Durante il periodo di validità dell'autorizzazione e finché refresh_token è ancora valido, è possibile estendere il periodo di validità di refresh_token tramite l'operazione di aggiornamento

code

string

false

Codice di autorizzazione, restituito da eSignGlobal dopo che l'utente ha autorizzato, obbligatorio quando grant_type è authorization_code

refresh_token

string

false

Token di aggiornamento, è necessario fornire il token di aggiornamento solo quando grant_type è refresh_token

Tutti i parametri devono essere inviati tramite multipart/form-data in formato modulo, non possono essere utilizzati come parametri di query URL o corpo della richiesta JSON.

Esempio di richiesta

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

Parametri di risposta

Nome parametro

Tipo

Descrizione

access_token

string

Token di autenticazioneUtilizzato per l'autenticazione delle richieste API, valido per 1 giorno naturale

expires_in

int

Tempo rimanente prima della scadenza del token, in secondi

scope

string

Ambito delle autorizzazioni

  • Quando grant_type è client_credentials, restituisce il valore fisso:read-write
  • Quando grant_type è authorization_code o refresh_token, restituisce l'ambito di autorizzazione corrispondente

token_type

string

Tipo di token

Valore fisso: bearer

refresh_token

string

Utilizzato per aggiornare il token, restituito solo quando grant_type è authorization_code o refresh_token, valido per 30 giorni naturali, dopo la scadenza è necessario riautorizzare

Esempio di risposta

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

 

Descrizione dell'interfaccia
Parametri di richiesta
Esempio di richiesta
Parametri di risposta
Esempio di risposta