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