APIキーの取得
UTAGE管理画面からAPIキーを発行します。- UTAGE管理画面にログイン
- 右上メニューの API設定 を開く
- 「追加する」をクリック
- 管理名称を入力し、API利用ポリシーに同意して「保存」
- 表示されたAPIキーをコピーして安全な場所に保存
認証方法
全てのAPIリクエストにAuthorization ヘッダーでAPIキーを送信します。
curlでのテスト
401 Unauthorized エラーが返ります。
エラーレスポンス例
リクエストの文字コード
リクエストボディは UTF-8 でエンコードしてください。UTF-8 以外の場合は400 invalid_encoding エラーが返ります。
セキュリティ
- APIキーはハッシュ化して保存されます。平文では保存されません
- 全てのAPIリクエストはログに記録されます
- 不要になったAPIキーは管理画面から無効化してください
レート制限
APIにはレート制限があります。レスポンスヘッダー
全てのAPIレスポンスに、現在のレート制限状況を示すヘッダーが含まれます。制限超過時
レート制限を超過すると429 Too Many Requests が返ります。
リソース作成上限
レート制限とは別に、データを作成するAPIには作成数の上限があります。超過すると429 が返ります。
details.resource_type に対象のリソース種別が含まれます。
読者作成（
POST /accounts/{account_id}/scenarios/{scenario_id}/readers および POST /accounts/{account_id}/line/friends/{friend_id}/readers）は、短時間に多数登録されるケースに対応するため分間レート制限の対象外です。代わりに上記のリソース作成上限（時間・月間）で制御されます。