APIトークン

APIトークンは、システムユーザーとしてシステムへのフルアクセスが可能となる強力な認証情報です。

Info

リクエストヘッダーで使用するアクセストークンはアクセストークン発行から作成することが可能です。
※発行済みAPIトークンをリクエストヘッダーに使用することはできません。

APIトークンの有効期限は無期限です。ただし失効操作を行うことで発行済みのAPIトークンを破棄することが可能です。

実行ユーザーは「システムユーザー」となり、契約プラン内の全機能へのアクセス、設定、操作をする権限を持ちます。

Warning

発行したAPIトークンは、第三者に知られないように注意してください。

APIトークン発行

システム設定

https://gateway-esm.softbrain.com/sheet-fs/{tenant}/pub/esms/auth/apitoken

GET

No.	パラメータ	必須	タイプ	デフォルト値	説明
1	tenant	○	string	-	テナントID

No.	ヘッダー名	必須	説明
1	Authorization	○	"Bearer"とアクセストークンを半角スペースで結合した値

Authorization: Bearer ey....

No.	プロパティ名	項目名	タイプ	備考
1	apiToken	APIトークン	string
2	userId	システムユーザID	string

{
    "apiToken": "ey....",
    "userId": "SYSTEM"
}

システム設定

https://gateway-esm.softbrain.com/sheet-fs/v1/{tenant}/pub/esms/auth/apitoken

DELETE

No.	パラメータ	必須	タイプ	デフォルト値	説明
1	tenant	○	string	-	テナントID

No.	ヘッダー名	必須	説明
1	Authorization	○	"Bearer"とアクセストークンを半角スペースで結合した値

"Authorization": "Bearer ey...."

No.	プロパティ名	必須	項目名	タイプ	備考
1	apiToken	○	APIトークン	string	発行済みAPIトークン

{
    "apiToken": "ey...."
}