概要

PigeonCloudでは、外部システムとの連携のためにREST APIを提供しています。APIを利用することで、テーブル情報の取得やレコードの取得・作成・更新・削除などの操作をプログラムから実行できます。

APIの利用にはAPIオプションの契約が必要です。

各エンドポイントの詳細な仕様（リクエスト・レスポンス形式、パラメータ、サンプルコード等）は、APIリファレンスにまとめています。

APIリファレンスを開く →

認証方法

すべてのAPIリクエストには認証が必要です。リクエストヘッダーに X-Pigeon-Authorization を含めてください。

curl -H "X-Pigeon-Authorization: {API_KEY}" \
     https://your-domain.pigeon-cloud.com/api/v1/table

APIキーは {ID}:{PASSWORD} をBase64エンコードした値です。管理メニューの「API設定」からAPIキーの発行・管理が行えます。

利用できるエンドポイント

操作 メソッド エンドポイント
テーブル一覧取得 GET /api/v1/table
テーブル項目定義取得 GET /api/v1/fields
レコード一覧取得 POST /api/v1/get_record
レコード作成 POST /api/v1/record
レコード更新 PUT /api/v1/record
レコード削除 POST /api/v1/delete_record
全レコード削除 POST /api/v1/delete-all-record
ファイルダウンロード GET /api/v1/file
ジョブステータス確認 GET /api/v1/job-status/{job_id}

各エンドポイントの詳細なパラメータやレスポンス形式については、APIリファレンスを参照してください。

アクセス制限

安定したサービス運用のため、以下のアクセス制限が設けられています。

制限項目 上限
1秒あたりのリクエスト数 1回
1時間あたりのリクエスト数 1,000回
1日あたりのリクエスト数 制限なし

※レコード数に関わらず、1コールを1回としてカウントします。

制限を超えた場合はHTTPステータスコード 429 Too Many Requests が返されます。時間を置いてからリクエストを再実行してください。

注意事項

  • APIキーは第三者に漏洩しないよう厳重に管理してください
  • APIリクエストはHTTPS通信で行ってください
  • 大量のリクエストを短時間で送信するとレート制限に抵触する場合があります
  • APIの利用にはAPIオプションの契約が必要です