APIキーとユーザープロビジョニング API

ユーザープロビジョニング API を使用すると、チームをプログラムで管理できます。ユーザーの招待と削除、チームメンバーとその使用状況の一覧表示、保留中の招待の一覧表示、独自のシステムからの予約の作成が可能です。

API へのアクセスは APIキーで認証され、APIキーはワークスペースのオーナーが設定 → APIキーで管理します。

APIキーを生成する

1. 設定 → APIキーに移動し、新しいキーを生成をクリックします。
2. キーの目的を表す名前を付けます。
3. アクセス種別を選択します：フルアクセスまたは読み取り専用。読み取り専用のキーは変更を行えません。
4. 有効期限を選択します：7日、30日、90日、1年、または無期限。

キーの値は、生成直後に一度だけ表示されます。再表示はできないため、必ずすぐにコピーしてください。

API を使用する

キーを x-api-key ヘッダーで送信します。ベース URL は次のとおりです：

https://app.onecal.io/api/v1

認証、ページネーション、レート制限、すべてのエンドポイントを含む完全な API リファレンスは、apidocs.onecal.io にあります。

キーを監視および取り消す

APIキーの一覧には、各キーの生成日、有効期限、最終使用日が表示されるため、未使用のキーや期限が近いキーを見つけることができます。

取り消すをクリックすると、キーが無効になります。そのキーを使用しているアプリは直ちに動作を停止し、取り消しは元に戻せません。ユーザーがチームから削除されると、そのユーザーに属するキーも自動的に取り消されます。