Qamaq APIドキュメント
Qamaq APIで強力な統合を構築しましょう。エンティティ、ナレッジベース、ワークフローなどにアクセスできます。
クイックスタート
1
APIキーを取得
Qamaqダッシュボードの「設定」>「APIキー」に移動して、新しいAPIキーを作成します。キーは表示された直後にコピーしてください。再度表示されません。
2
最初のリクエストを送信
Bearerスキームを使用して、AuthorizationヘッダーにAPIキーを含めてください：
リクエスト例bash
curl -X GET "https://api.qamaq.io/api/v1/entities" \
-H "Authorization: Bearer qmq_your_api_key"3
APIを探索
以下のAPIリファレンスを閲覧して、利用可能なすべてのエンドポイントと機能を確認してください。
API機能
ベースURL
すべてのAPIリクエストは以下に送信してください：
https://api.qamaq.io/api/v1APIバージョニング
APIバージョンはURLパスに含まれます。現在の安定バージョンはv1です。
破壊的な変更は十分に事前にアナウンスし、可能な限り後方互換性を維持します。
レート制限
APIは公平な使用を確保するためにレート制限を実装しています。現在の制限：
1000
リクエスト/分
10,000
リクエスト/時
100,000
リクエスト/日
注意： レート制限ヘッダーはすべてのレスポンスに含まれます。制限を超えた場合、429 Too Many Requestsレスポンスが返されます。より高い制限が必要な場合はお問い合わせください。
エラーハンドリング
APIは標準のHTTPステータスコードを使用してリクエストの成功または失敗を示します：
200OKリクエスト成功
201Createdリソースの作成に成功
400Bad Request無効なリクエストパラメーター
401UnauthorizedAPIキーが不正または欠落
403ForbiddenAPIキーに必要な権限がありません
404Not Foundリソースが見つかりません
422Validation Errorリクエストの検証に失敗
429Too Many Requestsレート制限超過
500Server Error内部サーバーエラー