APIエクスプローラー

CCWのREST APIエクスプローラーは、ユーザーが次の方法でCCW APIをテストおよび探索できる対話型ツールです。

• 利用可能なREST APIリソースとエンドポイントを参照する
• 各APIで利用可能なメソッド、サポートされているパラメーター、インラインドキュメントについて説明します
• 利用可能な任意のAPIエンドポイントに対するサンプル申請を提出して試し、リアルタイムで応答を確認します
• 技術的なバックグラウンドを必要としない直感的なフレームワークを通じて、認証および承認されたAPI呼び出しを行います

APIエクスプローラーを使用するには、最初にCCWサポートからCCWのREST APIへのアクセスを要求する必要があります。を確認してください CCW API概要ドキュメント APIへのアクセス方法と使用方法の詳細を確認してください。

エクスプローラーにアクセスする

開始するには、以下に移動します。 インテグレーションツールキット>インテグレーションドキュメント 。ボタン REST APIエクスプローラー。

現在利用可能なAPIが表示されます。

• 候補者検索（/api/候補/検索）
• 候補者確認(/api/candidates/{id}/confirm)
• 臨時従業員検索(/api/contingent_workers)

［ ベースURL は、APIリクエストの送信に使用され、現在のCCWテスト環境を表します。

CCWが追加するAPIは、 タグでフィルタリング バーでは、セクションヘッダーに一致するキーワードを入力して、特定のAPIを検索できます。

APIのテスト

テストするAPIをクリックすると、フォームが展開され、 名前 および 説明 利用可能なパラメーター：

特定のパラメーターには、 値の例 （既定で表示） および モデル （各フィールドのプロパティを表示するにはクリック）。

［ 回答 セクションには、CCWからのAPI応答に含まれる可能性があるコード番号（説明を含む）が含まれています。

ボタン 試してみる エクスプローラーフォームでサンプル申請を手動で編集できます。

CCW APIリクエストの適切なフォーマットやその他の要件については、それぞれのAPIのドキュメントを確認してください。

• 候補者検索API
• 候補者確認API
• 臨時従業員検索API

X相関ID、 必須フィールド、自動生成時 試してみる をクリックします。

承認、 また必須、 には、エクスプローラー以外で生成する必要があるアクセストークンが必要です。生成されると、アクセストークンは1時間続きます。

ボタン 実行 をクリックして、入力した追加のパラメーターを使用してベースURLにリクエストを送信します。または、 キャンセル 変更を破棄します。

実行後、 回答 セクションには、APIリクエストに応答して送信されたレスポンス本文、ヘッダー（および該当する場合はエラー）が含まれます。詳細については、上記のリンク先のドキュメントを確認してください。