• 最終編集日時: 31 May 2021

CCW APIの概要

CCWのREST APIを使用すると、顧客とパートナーは新しいアプリケーションを構築し、新しい方法でCCWと統合して、派遣労働力の管理に関する能力を向上させることができます。

CCWのREST APIを使用する顧客とパートナーは、新しいアプリケーションを構築し、新しい方法でCCWと統合して、派遣労働力の管理に関する能力を向上させることができます。CCWのAPIは、認証にOAuth 2.0、トランスポートレイヤーセキュリティにTLS 1.2を使用するHTTPベースのRESTful APIです。このドキュメントでは、CCWのAPIにアクセスし、必要なデータを取得するためのリクエストを行う方法について説明します。

認証

CCW REST APIにアクセスしたいお客様は、APIコンシューマーアプリを登録し、OAuth 2.0クライアント資格情報を受け取って、2つの追加のセキュリティレイヤー(スコープとユーザー/ロールアクセス権)と組み合わせて使用し、CCW APIへの要求を認証することができます。

認証要件 説明
OAuth 2.0資格情報 クライアントIDとクライアントシークレットを含みます
範囲 要求されているCCW内の特定のモジュール/機能を指し示すエンドポイント
ユーザー/ロールアクセス権 CCWアプリケーション内で割り当てられます。APIで認証されると(以下を参照)、別のセキュリティ層が要求されている特定の機能へのアクセスを決定します

アクセストークン

CCW APIにアクセスするには、次の例のように、OAuth認証情報とスコープを使用して呼び出しを実行してアクセストークンを要求する必要があります。

curl - XPOST - H "Content - type: application/json" -<<clientID> d '{" client_id ":">"," client_<<secret>secret ":">", 

"scope ":" ccw.candidate ", "grant_type ":" client_credential "} '' Auth_Url '

'Auth_Url'の場合は、環境に応じて以下を使用します:

認可サーバーは以下を含むJSONペイロードを返します:

プロパティ
token_type 「Bearer」の接頭辞
access_token APIリクエストを行うときに認証ヘッダーに含まれる文字列
expires_in トークンの有効期限が切れるまでの秒数(通常は3600、または1時間)

API終点

CCW APIエンドポイントへの呼び出しで受信したアクセストークンを含みます。要求が検証される(またはエラーを返す-「エラーコード」を参照)。

エンドポイント形式: https ://<instance>/api/<resource path>

例:

  • 応募者確認: https ://{ hostname }/ API/candidates /{ id }/ confirm
  • 応募者検索: https ://{ hostname }/ API/candidates/search
  • 派遣労働者( CW )ルックアップ: https ://{ hostname }/ API/contingent_workers

申請ヘッダー

次のHTTP要求ヘッダーが必要です。

ヘッダー 説明
認可 API呼び出しへのアクセスを要求するために使用されます。認証スキームにベアラートークンを含めます。 ベアラー: <Token>
Content - Type すべて のリクエストで: application/jsonに設定します。JSONは現在サポートされている唯一の交換フォーマットです
X - Correlation - id API要求の追跡と監査を可能にするために生成される最大36文字の識別子

エラー回答

サンプルエラー応答

{

 "error_code ":"文字列",

 "ERROR_SUMMARY ":"文字列", 

 "error_causes ": [

  {

   "error_sub_code ":"文字列",

   "error_sub_code_desc ":"文字列"

  }

 ]

}

エラーコード

各特定のCCW APIのエラーコードセクションを参照してください。

レート制限

CCW REST APIには明示的なレート制限はありませんが、API要求の調整はタイムリーな応答のために推奨されます。まもなく、個々のAPIエンドポイントは、推奨されるレート制限でアップデートされます。

ベストプラクティス

REST APIを使用してCCW上にアプリケーションを構築する際に、最良の結果を確保するためのヒントを以下に示します。

  1. スキーマ検証を避けます。 CCW APIは常に進化しており、新しいオプションのプロパティがAPIに追加されています。拡張性のため、アプリケーションはスキーマ検証を実行しないでください。これにより、APIが不要な可能性のある新しいプロパティを送信したときにエラーが発生する可能性があります。
  2. HTTPステータスコードを使用: コンシューマーアプリケーションは、診断およびロギングのみを目的とした応答本文の内容ではなく、APIエラーを処理するためのHTTPステータスコードに依存する必要があります。
  3. API応答のプロパティの順序に依存することは避けてください。 CCW APIはJSONコンテンツのみをサポートしています。API応答のプロパティの順序は、新しいプロパティの導入により変更される場合があります。

 

関連アイテム


候補者検索API

31 May 2021

CCWの候補者検索APIを使用すると、顧客はCCWの申請書に提出された候補者に関するデータを取得できます。

候補者確定API

31 May 2021

サードパーティアプリケーションを介して候補者のオンボーディングアクティビティの一部またはすべてを管理する顧客は、CCW候補者確認APIを使用して、候補者を派遣労働者として一度に1人ずつ確認するプロセスを自動化できます。

APIエクスプローラー

31 May 2021

CCWのREST APIエクスプローラーは、ユーザーがCCW APIをテストして探索できるインタラクティブなツールです。

Coupa Core API

RESTful APIは、Coupaプラットフォームでデータの読み取り、編集、統合を行うための堅牢なアクセスを提供します。