API tokens¶

personal access token を使うと、スクリプトや CI ジョブ、その他の連携から、Empi の REST API を あなた自身として 呼び出せます。あなたに見えるものだけが見え、あなたが 変更できるものだけを変更できます。

トークンを作成する¶

1. Settings > API を開きます。
2. Create token をクリックします。
3. 後で見分けられるように Name（例: "CI pipeline"）を付けます。
4. Permissions を選びます: Read-only（GET リクエストのみ）または Read & write（読み取りとデータの変更）。
5. Expiration を選びます: 7 days、30 days、90 days、1 year、または no expiration。
6. Create をクリックし、secret をコピーします。

各トークンの行には、有効期限といつ最後に使われたかが表示されるので、忘れていた トークンにも気づけます。

トークンを使う¶

API リクエストに bearer token として付与してください。エンドポイントの一覧、 パラメーター、レスポンスの詳細は API reference に あります。

トークンを失効させる¶

トークンの行にある Revoke をクリックして確定します。トークンは即座に使えなく なり、復元はできません。引き続きアクセスが必要な場合は、新しいトークンを作成して ください。

トークンを使って行われた呼び出しは、activity log では API に 起因するものとして記録されます。