oAuth-Autorisierung

POST /esignglobal/v1/oauth2/accessToken

Schnittstellenbeschreibung

Durchapp_idundapp_secretAuthentifizierung erhaltenaccess_token，um eSignGlobal API als spezifischer Benutzer anzufordern. Die Gültigkeitsdauer des Tokens beträgt 24 Stunden.

Anfrageparameter

Parametername	Typ	Erforderlich	Beschreibung
client_id	string	true	Anwendungskonto, d. h. app_id Bitte registrieren Sie zuerst ein eSignGlobal-Konto und erstellen Sie eine Anwendung, um es zu erhalten.
client_secret	string	true	Anwendungspasswort, d. h. app_secret Bitte registrieren Sie zuerst ein eSignGlobal-Konto und erstellen Sie eine Anwendung, um es zu erhalten.
grant_type	string	true	Autorisierungstyp, unterstützt die folgenden Typen: client_credentials:Basiert auf client_id und client_secret, um einen access_token zu erhalten authorization_code:Benötigt die Teilnahme des Benutzers am Autorisierungsprozess (Gültigkeit beträgt 365 Kalendertage). Nach der Autorisierung können access_token und refresh_token abgerufen werden refresh_token:Innerhalb der Gültigkeitsdauer der Autorisierung und solange der refresh_token noch gültig ist, kann die Gültigkeitsdauer des refresh_token durch eine Aktualisierung verlängert werden
code	string	false	Autorisierungscode, der nach der Benutzerautorisierung von eSignGlobal zurückgegeben wird. Erforderlich, wenn grant_type authorization_code ist
refresh_token	string	false	Refresh-Token, nur erforderlich, wenn grant_type refresh_token ist

Alle Parameter müssen über multipart/form-data im Formularformat übermittelt werden und dürfen nicht als URL-Abfrageparameter oder JSON-Anfragetext verwendet werden.

Beispielanfrage

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

Antwortparameter

Parametername	Typ	Beschreibung
access_token	string	Authentifizierungs-Token，Wird für die Schnittstellenanforderungsauthentifizierung verwendet und ist 1 Kalendertag gültig
expires_in	int	Verbleibende Zeit bis zum Ablauf des Tokens, Einheit: Sekunden
scope	string	Berechtigungsbereich Wenn grant_type client_credentials ist, wird ein fester Wert zurückgegeben:read-write Wenn grant_type authorization_code oder refresh_token ist, wird der entsprechende Autorisierungsbereich zurückgegeben
token_type	string	Token-Typ Fester Wert: bearer
refresh_token	string	Wird zum Aktualisieren des Tokens verwendet, nur wenn grant_type authorization_code oder refresh_token ist. Die Gültigkeitsdauer beträgt 30 Kalendertage. Nach Ablauf muss eine erneute Autorisierung erfolgen

Beispielantwort

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