API Gateway 概要

は、サポートされているプラットフォーム統合のパブリックエントリCHAMPREPAPI Gatewayポイントです。ここでは、認証情報の検証、スコープおよびサービスへのアクセス権の確認、現在の利用制限の適用が行われ、承認されたリクエストは関連する CHAMPREPサービスへとルーティングされます。

ベースURL

https://api.champrep.com/v1

厳選されたパブリックルートは、以下でバージョン管理されています： /v1。サーバーアプリケーションでは完全な HTTPS URL を使用し、コード全体にベース URL を散りばめるのではなく、環境設定を使用してください。

最初の認証済みリクエスト

でスコープ付きキーを作成し、 API キー、それをベアラー認証情報として渡してください：

curl --fail-with-body \
  --header "Authorization: Bearer $CHAMPREP_TOKEN" \
  --header "Accept: application/json" \
  https://api.champrep.com/v1/auth/whoami

実際のキーを、ソース管理、ブラウザバンドル、モバイルバイナリ、サポートメッセージ、またはドキュメントに決して記載しないでください。デプロイされた統合については、サーバーサイドのシークレットマネージャーをご利用ください。

リクエストの規約

エンドポイントで別のメディアタイプが明示的に指定されていない限り、JSON を送信および受信してください。
日付および時刻の値には、タイムゾーンを明示した ISO 8601 形式のタイムスタンプを使用してください。
パスおよびクエリ値はURLエンコードしてください。
ベアラー認証情報を Authorization ヘッダー。
識別子は不透明な文字列として扱い、その形式を推測したり、ローカルで生成したりしないでください。
キュレーション済みの /v1 ルートは、サービスエンドポイントリファレンス.

Official は、サービスがキュレーションされたサービスへ移行中の間、Gateway 互換ルートを使用する場合SDKsがあります。 /v1 契約。この互換性レイヤーは SDK; 新しい直接統合では、ブラウザトラフィックや内部SDKシステムからバックエンド専用のパスをコピーしてはなりません。

レスポンスエンベロープ

ゲートウェイによって生成された正常なレスポンスは、以下の形式になります：

{
  "success": true,
  "data": {}
}

ゲートウェイエラーは、以下の形状で表示されます：

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "A safe explanation of the error.",
    "status": 400
  }
}

プロキシ経由のサービス応答の中には、サービス固有のデータエンベロープが保持されているものがあります。必ず最初にHTTPステータスを確認してから、内容を読み取ってください。 success, data、または error （存在する場合）。詳細については、エラー、制限、および再試行をポータブルなエラー処理に活用してください。

認証および承認フロー

すべてのサービスリクエストは、以下の順序で評価されます：

ゲートウェイは、キーAPIおよび設定されたIP制限を検証します。
現在のゲートウェイ使用状況ウィンドウがチェックされています。
API Gateway へのアクセスは、有効なプランおよびプロファイルに基づいて確認されます。
宛先サービスへのアクセスが確認されました。
キーのスコープは、ルートおよびHTTPメソッドと照合されます。
宛先サービスは、独自のロール、組織、リソース、およびクォータのチェックを適用します。

A 403 したがって、キーが有効であっても、アクティブなスコープ、ロール、サービスへのアクセス、プラン、組織ポリシー、またはリソースの権限によって、その操作が許可されない場合があります。

バージョン管理

最初のURLセグメントはメジャーAPIバージョンです。メジャーバージョン内では、追加のレスポンスフィールドや新しいエンドポイントが現れる場合があります。統合では、未知のフィールドを無視し、文書化されていないフィールドや順序に依存しないようにしてください。

使用方法 GET /v1/version を参照して、Gatewayの公開バージョン情報を確認してください。将来のメジャーバージョンへの移行は、コードを書き換えるのではなく、明示的に計画してください。 /v1 パスは実行時に。

次の手順

最小権限のキーを作成する.
サービスルートを選択してください.
制限とエラーの処理.
頻繁なポーリングの代わりに Webhook をご利用ください.
ターミナルでの作業を好まれますか？をインストールしてください。 CHAMPREPCLI.