Buzzley
無料で試す
APIキー：
このドキュメントは英語版が正式な参照先です。この翻訳は参考用であり、最新の内容を反映していない場合があります。

APIドキュメント

Buzzley REST APIで連携を構築できます。14個のリソースグループに49件のエンドポイントがあります。

認証

すべてのAPIリクエストでは、Bearer方式でAuthorizationヘッダーにAPIキーを含める必要があります。APIキーはAPIキーのページで作成・管理できます。

curl https://api.buzzley.app/api/v1/reminders \
  -H "Authorization: Bearer bzl_your_api_key_here"

ベースURL

すべてのエンドポイントは次のURLからの相対パスです：

https://api.buzzley.app/api/v1

レート制限

アカウントごとに1分あたり60リクエスト、1日あたり10,000リクエストまで送信でき、この上限はアカウントのすべてのAPIキーで共有されます。すべてのリクエストのレスポンスに次のヘッダーが含まれます：

ヘッダー説明
X-RateLimit-Limit1分あたりの最大リクエスト数
X-RateLimit-Remaining現在の期間の残りリクエスト数
X-RateLimit-Resetレート制限がリセットされるまでの秒数

上限を超えると、retry_afterフィールドを含む429レスポンスが返されます。

レスポンス形式

すべてのレスポンスはJSONです。成功時のレスポンスでは、ペイロードがdataフィールドに入ります。エラー時は、機械可読なcodeと人が読めるmessageを持つerrorオブジェクトが返されます。

// Success
{
  "data": { ... }
}

// Error
{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "title is required"
  }
}

エラーコード

ステータスコード説明
400INVALID_REQUESTリクエストボディまたはパラメーターが無効です
401UNAUTHORIZEDAPIキーがないか、無効です
403FORBIDDENこのAPIキーにはこの操作の権限がありません
404NOT_FOUNDリクエストしたリソースは存在しません
409CONFLICTリソースがすでに存在するか、状態が競合しています
429RATE_LIMITEDリクエストが多すぎます。指定された時間が経過してから再試行してください
500INTERNAL_ERROR予期しないサーバーエラーが発生しました

エンドポイントリファレンス

Ping1件のエンドポイント

APIキー1件のエンドポイント

APIキーでは、キーの一覧表示はできますが、キーの作成・無効化やアカウントの削除はできません。これらの呼び出しはAPIキーに対して403を返します。キーの作成と無効化は、ログインした状態でAPIキーのページから行ってください。

リマインダー7件のエンドポイント

インスタンス4件のエンドポイント

インスタンスは、繰り返しリマインダーの個々の回を表します。

カテゴリ4件のエンドポイント

テンプレート6件のエンドポイント

スヌーズのプリセット4件のエンドポイント

設定2件のエンドポイント

グループ8件のエンドポイント

すべてのアカウントはいずれかのグループ（家族、チーム、個人）に属します。デバイス数の上限はグループ単位で適用されます。オーナー専用の操作では、APIキーの所有者がグループのオーナーである必要があります。

デバイス2件のエンドポイント

プロフィール1件のエンドポイント

分析1件のエンドポイント

サブスクリプション1件のエンドポイント