開発者向けツール

CHAMPREP 開発者向けツールは、個々のサービスバックエンドを呼び出すことなく、サポートされているワークフローを一貫した方法で自動化する手段を提供します。認証、サービスへのアクセス、スコープ、使用制限、および監査コンテキストは、API Gateway側で適用されます。

統合パスを選択してください

パス	最適なのは	ここから始めましょう
API Gateway	HTTPS による直接統合およびカスタムアプリケーション	API Gateway 概要
CHAMPREP CLI	対話型ターミナル操作、スクリプト、およびCIジョブ	CLI 概要
Webhook	ポーリングを行わないべきイベント駆動型統合	Webhook
公式 SDKs	サポートされているサービスおよびフレームワーク向けの型付きクライアント	CHAMPREP SDKs
SCIM 2.0	エンタープライズ ID プロバイダーによるプロビジョニング	SCIM プロビジョニング

ネットワーク経由のすべてのコマンドCLIおよび公式のリクエストSDKは、ゲートウェイを使用します。サービスのブラウザ向けURLやバックエンド専用の URLに対して統合機能を構築することは避けてください。これらのルートは、安定した公開契約ではありません。

クイックスタート

にサインインしCHAMPREP、[API Keys] を開いてください。 API キー.
統合に必要なスコープのみを含むキーを作成してください。
キーは、シークレットマネージャーまたはオペレーティングシステムのキーチェーンに保存してください。
本番環境のゲートウェイにリクエストを送信します：

export CHAMPREP_TOKEN='replace-with-your-api-key'

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

応答には、アクティブなアカウントと認証情報のコンテキストが示されます。引き続き認証とキーAPI サービススコープを追加する前に。

プラットフォームの制御は引き続き適用されます

有効なキーであっても、に適用される製品制御をバイパスすることはできませんCHAMPREP。リクエストは、以下のすべての条件が満たされている場合にのみ実行されます：

API Gateway アクティブなプランおよびプロファイルでは、アクセスが有効になっています。
対象のサービスは、アクティブなプランおよび組織で利用可能です。
このキーには、メソッドおよびリソースに必要なスコープが含まれています。
分単位、日単位、およびサービスごとのリアルタイム使用量制御により、これが可能となります。
アクティブなロールは、宛先サービスでの操作を実行する権限を持っています。

このため、APIAPIキーは、アカウント、プラン、ロール、または組織のポリシーを回避する手段としてではなく、同じアカウントへの追加のインターフェースとして扱う必要があります。

リファレンスマップ