oAuth認証

POST /esignglobal/v1/oauth2/accessToken

インターフェースの説明

経由app_idとapp_secret認証を取得access_tokenして、特定のユーザーとしてeSignGlobal APIをリクエストするために使用します。トークンの有効期間は24時間です。

リクエストパラメータ

パラメータ名	タイプ	必須	説明
client_id	string	true	アプリケーションアカウント、つまりapp_id 最初にeSignGlobalアカウントを登録し、アプリケーションを作成してから取得してください。
client_secret	string	true	アプリケーションパスワード、つまりapp_secret 最初にeSignGlobalアカウントを登録し、アプリケーションを作成してから取得してください。
grant_type	string	true	認証タイプ。以下のタイプをサポートします： client_credentials：client_idとclient_secretに基づいてaccess_tokenを取得します authorization_code：ユーザーが承認プロセスに参加する必要があります（有効期間は365日）。承認が完了すると、access_tokenとrefresh_tokenを取得できます refresh_token：承認の有効期間内であり、refresh_tokenがまだ有効な場合は、更新操作によってrefresh_tokenの有効期間を延長できます
code	string	false	認証コード。ユーザー認証が完了するとeSignGlobalから返されます。grant_typeがauthorization_codeの場合は必須です
refresh_token	string	false	リフレッシュトークン。grant_typeがrefresh_tokenの場合にのみ、リフレッシュトークンを提供する必要があります

すべてのパラメータは、multipart/form-data フォーム形式で送信する必要があります。URLクエリパラメータまたはJSONリクエストボディとして使用することはできません。

リクエスト例

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

レスポンスパラメータ

パラメータ名	タイプ	説明
access_token	string	認証トークン，インターフェースリクエスト認証に使用され、有効期間は1暦日です。
expires_in	int	トークンの有効期限までの残り時間（秒単位）
scope	string	権限範囲 grant_typeがclient_credentialsの場合、固定値：read-write grant_typeがauthorization_codeまたはrefresh_tokenの場合、対応する認証範囲を返します。
token_type	string	トークンタイプ固定値：bearer
refresh_token	string	トークンの更新に使用されます。grant_typeがauthorization_codeまたはrefresh_tokenの場合にのみ返され、有効期間は30暦日です。期限切れ後は再認証が必要です。

レスポンス例

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