ここでは、eurie Desk の REST API に必要な App Token 管理について解説します。App Token 管理ページ (/desk/admin/app_tokens) について解説します。Admin Role を持つ User のみがアクセスできます。

Token とは

Token は REST API を利用する場合に利用します。HTTP リクエストに付与された Token が適切な内容だった場合にリクエストが受け付けられます。

Token は以下を例とする JWT (JSON Web Token) 形式の文字列です。

eyJhbGciOiJFUzUxMiIsInR5cCI6IkpXVCJ9.eyJhY2NvdW50IjoiZGVtbzEiLCJhcHBsaWNhdGlvbiI6IkRlc2siLCJhdWQiOiJkZW1vMS5ldXJpZS5pbyIsImlhdCI6MTQ4MDQwMTk1MywiaXNzIjoiZXVyaWUuaW8iLCJqdGkiOiJGd2t0eU52VE1GOE5SV1RZd1VqZnJKIiwidHlwIjoiYXBwVG9rZW4ifQ.Adap-xxxxxxxx-xxxxxxxxxxxxxx-xxxxxxxxxxxxx-xxxxxxxxxxxxxx-xxxxxxxxxxxxx-xxxxxxxxxxxxxx

App Token 管理ページではこの Token の発行および削除が行えます。

App Token の発行

App Token を発行するには、Name および Description を入力します。

local_offer Name
Token の名称です。利用用途やトークンの利用箇所
local_offer Description
Token の説明文です。

現在選択できる Role は POSTAL CARRIER のみです。POSTAL CARRIER とは、メッセージ投稿に限定した操作を行うことができる App Token 用の Role です。

情報を入力したら、「GENERATE」を選択し Token を発行します。

Token が正常に発行されると、Token の情報が表示されます。

Token 情報が表示されるのはこの一度きりであることに注意してください。Token を取得できなかった場合、紛失した場合は別の Token を発行してください。

この Token は大切な情報です。外部には漏らさないよう充分ご注意ください。

App Token の一覧と削除

作成した Token は一覧に表示されます。

Token を削除したい場合、一覧から削除ボタンを選択してください。削除した Token は復旧できません。使用中の Token を誤って削除しないよう充分ご注意ください。