その仕組み

CCW APIとの連携を検討しているお客様とパートナーは、システムをAPIコンシューマーアプリとして登録する必要があります。これは、共通の認証情報セットでアクセス可能なCCW APIリソースのセットです。 アプリは、APIがアクセスできるリソースと実行できるアクションを制御する一連のAPIスコープと権限に関連付けられています。

新しいアプリを登録する

カスタマーインテグレーション管理者は、[ インテグレーションツールキット] > [APIコンシューマーアプリ ]に移動し、[ 作成 ]をクリックしてAPIコンシューマーアプリを登録できます。

APIアプリを作成するには、次の情報を入力します(すべてのフィールドが必須です)。

• アプリケーション名 - APIアプリを識別する名前を入力します。

• アプリケーションの説明 -アプリの用途を説明します。

• 連絡先の氏名/メールアドレス -アプリに技術的な問題がある場合に、CCWのサポートチームが連絡できる担当者の氏名とメールアドレスを入力します。

• アプリケーションタイプ -現在サポートされているのは、クライアント認証情報の付与タイプとのマシン間連携を必要とするOpenId Connectアプリのみです。 今後のリリースで、認証コード、デバイスコード、その他の付与タイプを必要とするWebアプリとデバイスアプリがサポートされます。

• アプリケーションカテゴリ -最も適切なカテゴリを選択します。顧客、パートナー、サプライヤー、またはMSP。

• アクティブ - アプリのステータスは、デフォルトでアクティブに設定されます。 チェックマークを外して、アプリを非アクティブにします。

• 認証情報タイプ - 共有シークレットに設定します。 これらの設定が保存されると、シークレットが生成されます。 将来のリリースでは、JSON Web Key (JWKS) ベースの資格情報タイプもサポートされる予定です。

• クライアントID (読み取り専用フィールド) - 自動生成されたクライアントIDは、OAuth 2.0クライアント認証情報の一部であり、CCW APIへのリクエストを認証するために使用されます。 クライアントIDは、「CCW」+クライアントプレフィックスで始まる一意のランダム文字列です。 クライアントIDをコピーするには、フィールドの右側にある[コピー]ボタンをクリックします。

• APIユーザー - 選択したアプリケーションカテゴリーに基づいて、事前定義されたAPIユーザー(クライアント、MSP、またはサプライヤーユーザーのいずれか)を選択します。

• スコープ -すべてのCCW APIには、特定のスコープまたはエンドポイントが必要です。 APIは現在、スコープで使用できます。

  • 候補者- ccw.candidates

  • 派遣労働者 - ccw.contingent_workersとして

保存をクリックします。 クライアントシークレットが生成され、緑色のバナーに表示されます。 クライアントシークレットをコピーして貼り付け、[X]をクリックしてバナーを閉じる前に、安全な場所に保存します。

アプリを表示

アプリが既にあなたや組織内の他のユーザーによって作成されている場合、[ Integration Toolkit] > [API Consumer Apps]に移動すると、既存のアプリを一覧表示するグリッドが表示されます。

ステータス列には、アプリがアクティブか非アクティブかが表示されます。 [ステータス]列の右側にある3つのドットをクリックして、その行のアプリを編集します。 非アクティブなアプリの場合は、アプリを削除するオプションも利用できます。

アプリの長いリストがある場合は、アプリの名前やカテゴリー、ユーザー(作成者列にリストされる)、日付(作成日と最終更新日列にリストされる)などを検索できます。 検索ボックスに入力し、虫眼鏡アイコンをクリックして結果を絞り込みます。

役割と権限

新しいアクセス権は、ユーザーが インテグレーションツールキット> APIコンシューマーアプリ にアクセスして既存のアプリを表示したり、新しいアプリを作成(登録)したり、資格情報を管理したりできるかどうかを決定します。

• インテグレーションツールキット> APIコンシューマーアプリ>ビューAPIクライアントアプリ - APIコンシューマーアプリのリストを表示するためのアクセスを可能にします。 既定で無効に設定されています。

• インテグレーションツールキット> APIコンシューマーアプリ> APIクライアントアプリの管理 - APIコンシューマーアプリを作成および管理するためのアクセスを可能にします。 既定で無効に設定されています。