APIコンシューマーアプリと認証情報を管理

顧客統合管理者またはVMSユーザーは、セルフサービス機能を介して、APIコンシューマーアプリを登録し、CCW APIにアクセスするために必要な資格情報を管理できます。

最新のCCW REST APIを介して認証するユーザーは、顧客統合管理者またはVMSユーザーがAPIコンシューマーアプリを登録し、APIにアクセスするために必要な資格情報を管理できる新しいセルフサービス機能により、セキュリティをより詳細に制御できるようになりました。

ワクチンの仕組み

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

新しいアプリを登録します。

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

api-client-apps2a.png

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

  • アプリケーション名- APIアプリを識別するための名前を入力します。
  • アプリケーションの説明-アプリの用途を説明します。
  • お問い合わせ先の氏名/メールアドレス-アプリに技術的な問題がある場合にCCWのサポートチームが連絡できる担当者の名前とメールアドレスを入力します。
  • アプリケーションタイプ-現在、クライアント資格情報の付与タイプとのマシン間 統合を必要とするOpenId Connectアプリのみがサポートされています。今後のリリースでは、認証コード、 デバイスコード、およびその他の助成金タイプを必要とするウェブアプリケーションとデバイスアプリがサポートされます。
  • 応募カテゴリー-最も当てはまるカテゴリーを選択してください。 顧客、パートナー、サプライヤー、またはMSP。
  • アクティブ-アプリのステータスは、デフォルトでアクティブに設定されています。チェックマークを外してアプリを無効にします。
  • 資格情報タイプ-共有シークレットに設定します。これらの設定が保存されると、シークレットが生成されます。将来のリリースでは、JSON Web Key (JWKS)ベースの資格情報タイプもサポートされます。
  • クライアントID (読み取り専用フィールド) -自動生成されたクライアントIDは、CCW APIへの要求を認証するために使用されるOAuth 2.0クライアント資格情報の一部です。クライアントIDは、"CCW" +クライアントプレフィックスで始まる一意のランダムな文字列です。クライアントIDをコピーするには、フィールドの右側にある[コピー]ボタンをクリックします。
  • APIユーザー-選択したアプリケーションカテゴリに基づいて、事前定義されたAPIユーザー(クライアント、MSP、またはサプライヤーのいずれかのユーザー)を選択します。

api-seeded-user1a.png

  • スコープ-すべてのCCW APIには、特定のスコープまたはエンドポイントが必要です。現在、スコープが設定されているAPIは次のとおりです。

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

api-client-secret2.png

ヒント

クライアントシークレットを紛失した場合は、アプリを編集し、[クライアントID]フィールドの横にある[生成]をクリックして資格情報を再生成する必要があります。セキュリティのため、クライアントシークレットはCCWシステムには保存されません。

アプリを見る

あなたや組織内の他のユーザーがすでにアプリを作成している場合、[ 統合ツールキット] > [APIコンシューマーアプリ]に移動すると、既存の アプリを一覧表示するグリッドが表示されます

api-client-apps1.png

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

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

役割と権利

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

  • インテグレーションツールキット> APIコンシューマーアプリ> APIクライアントアプリの表示 - APIコンシューマーアプリのリストを表示するためのアクセスを可能にします。既定ではオフになっています。
  • 統合ツールキット> APIコンシューマーアプリ> APIクライアントアプリの管理 - APIコンシューマーアプリの作成と管理にアクセスできます。既定ではオフになっています。

 

関連アイテム


候補者確定API

31 May 2021

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

候補者検索API

31 May 2021

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

CCW APIの概要

31 May 2021

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

APIエクスプローラー

31 May 2021

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