Actcast API
Actcast API を用いることでデバイスの操作などを自動化することができます。
Actcast API v0
詳細はAPI リファレンスでご確認ください。
API トークン
Actcast API を使用するためには API トークンが必要です。トークンは作成したユーザに紐付いており、それぞれのトークンがロールを持っています。
作成したユーザがグループから削除されると、そのユーザが作成したトークンも同時に削除されます。トークンを使ったシステム連携が予期せず停止しないよう、API トークンの棚卸もあわせてご覧ください。
API トークンの作成
- グループ設定ページの
Manage API Tokenボタンをクリックします。
- API トークン一覧ページの
Generate Newボタンをクリックします。
- トークンを作成します。トークンに紐づけ可能なロールはユーザのロールによって違いがあります。詳細はロールをご覧ください。
- 発行したトークンはこの時しか表示されないため、必ずメモを取っておいてください。
ロール
重要
作成者のロールが変わった場合でも、トークンのロールには影響がないことに注意してください。
Admin の場合
任意のロールを指定してトークンを作成することができます。
Admin ではない場合
トークン作成時に作成者と同じロールがトークンに割り当てられます。
API トークンの管理
グループ設定ページの API トークンの管理 から API トークン一覧ページを開きます。一覧には次の項目が表示されます。
| 項目 | 説明 |
|---|---|
| 作成者 | トークンを作成したユーザのメールアドレス |
| ロール | トークンに割り当てられたロール |
| API トークン | トークンの文字列。先頭の数文字を除いてマスクされます |
| 生成日時 | トークンを作成した日時 |
| 最終利用日時 | そのトークンで最後に Actcast API を呼び出した日時 |
| 説明 | トークンの用途などを記録しておくための自由記述 |
重要
最終利用日時が - と表示される場合、そのトークンが一度も使われていないか、最終利用日時を記録する機能の提供が始まる前にしか使われていないかのどちらかです。この 2 つは区別できません。提供開始より前に作成されたトークンについては、- であっても使われていない証拠にはなりません。
API トークン一覧ページには、Admin の場合のみ作成者で絞り込む欄が表示されます。また、作成者・ロール・生成日時・最終利用日時の各列は、見出しをクリックするとソートできます。1 ページあたりの表示件数は 10 / 25 / 50 / 100 件から選べます。
API トークン詳細ページ
API トークン一覧ページの行をクリックすると、そのトークンの API トークン詳細ページが開きます。一覧と同じ項目を確認できるほか、説明の編集とトークンの削除を行えます。
説明の編集
説明はトークンを作成した後でも変更できます。API トークン詳細ページの説明欄にあるアイコンをクリックしてください。
重要
説明を編集できるのは、そのトークンを作成したユーザ本人のみです。Admin であっても、他のメンバが作成したトークンの説明は編集できません。
トークンの削除
API トークン一覧ページの行をクリックして API トークン詳細ページを開き、タイトル右にあるメニューから削除します。誤操作を防ぐため、確認ダイアログで操作名の入力を求められます。
ロールによる違い
Admin の場合
- グループ内で作成されたトークンを、API トークン一覧ページと API トークン詳細ページで表示できます。
- グループ内で作成されたトークンを削除できます。
Admin ではない場合
- 自身で作成したトークンを、API トークン一覧ページと API トークン詳細ページで表示できます。
- 自身で作成したトークンを削除できます。
API トークンの棚卸
トークンは作成したユーザに紐付いているため、そのユーザが退職や異動によりグループから削除されると、トークンも削除されます。システム連携に使われているトークンが予告なく失効しないよう、メンバがグループを離れる前に棚卸を行ってください。
メンバを削除する前の確認
API トークンを持つメンバをグループから削除しようとすると、確認ダイアログが表示されます。ダイアログには、そのメンバが持っているトークンの個数と、メンバを削除するとトークンも削除され元に戻せないことが示されます。削除を実行するには、確認のため操作名の入力が必要です。
同じ内容は、Admin がメンバ詳細ページを開いたときにも表示されます。削除の操作を始める前に、そのメンバがトークンを持っているかどうかを確認できます。
いずれの表示からも、そのメンバが作成したトークンだけを絞り込んだ API トークン一覧ページへ移動できます。
引き継ぎが必要なトークンの見つけ方
グループから削除される / されたメンバに確認できる場合は、そのメンバが作成したトークンについて引き継ぎを依頼してください。
グループから削除される / されたメンバに確認できない場合は、最終利用日時が手がかりになります。本人がグループにいないにもかかわらず利用日時が更新され続けているトークンは、何らかのシステム連携に使われている可能性が高いと考えられます。API トークン一覧ページを最終利用日時でソートすると、そうしたトークンを見つけやすくなります。