APIエクスプローラー
CCWのREST APIエクスプローラーは、ユーザーがCCW APIをテストして探索できるインタラクティブなツールです。
CCWのREST APIエクスプローラーは、ユーザーが次の方法でCCW APIをテストして探索できるインタラクティブなツールです。
- 利用可能なREST APIリソースとエンドポイントを閲覧する
- サポートされているパラメーターとインラインドキュメントとともに、各APIで使用できるメソッドについて学びます
- 利用可能なAPIエンドポイントのサンプルリクエストを送信して実験し、リアルタイムで応答を表示する
- 技術的な背景を必要としない直感的なフレームワークを介して、認証および承認されたAPI呼び出しを行う
APIエクスプローラーを使用するには、まずCCWサポートからCCWのREST APIへのアクセスをリクエストする必要があります。APIにアクセスして使用する方法の詳細については、CCW API概要ドキュメントをご覧ください。
エクスプローラーへのアクセス
開始するには、次のページに移動します。 インテグレーションツールキット>インテグレーションドキュメンテーション 。[ REST APIエクスプローラー]をクリックします。
エクスプローラへの特定のアクセスは、右側の統合ツールキット>統合ドキュメントを割り当てることで、任意のCCWユーザーおよび/またはロールに与えることができます。
現在利用可能なAPIが表示されます。
- 候補者検索(/ api/candidates/search)
- 応募者確認(/ api/candidates /{ id }/ confirm)
- 有期契約作業員ルックアップ(/ api/contingent_workers)
API要求の送信に使用されるベースURLは、現在のCCWテスト環境を表します。
CCWがより多くのAPIを追加するにつれて、タグで絞り込むバーでは、セクションヘッダーに一致するキーワードを入力することで、特定のAPIを見つけることができます。
APIのテスト
テストするAPIをクリックすると、使用可能なパラメーターの名前と説明を示すフォームが展開されます。
特定のパラメーターには、Example Value （デフォルトで表示） とModel （クリックしてリストされている各フィールドのプロパティを表示）が含まれます。
レスポンスセクションには、CCWからのAPIレスポンスに含めることができるコード番号（説明付き）が含まれています。
エクスプローラーフォームのサンプルリクエストを手動で編集するには、[試してみる]をクリックします。
CCW API要求の適切なフォーマットおよびその他の要件については、各特定のAPIの文書を確認してください。
[試してみる]をクリックすると、必須フィールドであるX相関IDが自動的に生成されます。
承認も必須で、エクスプローラーの外部で生成する 必要があるアクセストークンが必要です。生成されると、アクセストークンは1時間続きます。
Postmanなどのアプリケーションを使用して、アクセストークンを生成し、Authorizationフィールドにコピーすることができます。Postmanで、Coupaから提供されたAPIアクセス資格情報（ Access Token URL、Secret、Scopeなど）を入力します。
[ 実行]をクリックして、入力した追加パラメーターを使用してベースURLに要求を送信します。または、[キャンセル]をクリックして変更を破棄します。
実行後、Responseセクションには、API要求に応答して送信された応答本文、ヘッダー(および該当する場合はエラー)が含まれます。詳細は、上記の文書を確認してください。