지금까지 Kore.ai 가상 비서 플랫폼에서 경고 작업을 설정하는 방법을 여기에서 확인했습니다. 이 섹션에서는, API 키를 사용한 권한 부여를 설정하는 방법을 살펴봅니다.

설정하기

API 키는 식별 및 인증을 위한 고유 식별자 및 시크릿 토큰 역할을 하여 연결된 API에 대한 일련의 액세스 권한을 제공할 수 있습니다. 최종 사용자에게 액세스를 위한 사용자 이름 및 암호를 묻는 대신 작업을 설정할 때 API 키만 묻는 메시지가 표시됩니다. API 키 권한 부여 유형을 사용하려면, 먼저 애플리케이션에 계정을 등록한 다음 애플리케이션의 API키를 생성하여 Kore.ai 권한 부여 메커니즘을 위한 설정을 구성합니다. 다음 그림에서는 API 키 권한 부여 유형을 위해 정의할 필드를 보여줍니다.

API 키 권한 부여 정의 방법:

1. 권한 부여 유형 필드에서 API 키를 선택합니다. 그런 다음 봇 빌더 사용자 인터페이스에 표시할 권한 부여의 이름을 지정합니다.

테넌시

필요한 경우, 하위 도메인 섹션에서, 웹 애플리케이션 또는 사용자 인터페이스의 기본 URL이 URL의 테넌트 이름을 사용하는 경우 예를 선택합니다. 예: kore는 테넌트를 www.kore.someCompany.com.으로 사용하는 웹 서비스의 테넌트 조직입니다. 다음 예시 설정에서, 테넌시 URL은 {tenant} 조직 플레이스 홀더를 포함합니다.

양식 필드

기본 사용자 이름과 암호 필드가 요구 사항을 충족하지 않는 경우, 권한 부여 양식 필드를 추가하여 최종 사용자에게 표시할 새 필드를 추가할 수 있습니다. 권한 부여 양식에 필드를 추가하려면,

• + 양식 필드 추가를 클릭합니다.

다음 그림은 권한 부여 대화 상자에 암호 필드를 추가하는 정의의 예입니다.

다음 표에서는 권한 부여 IDP 양식 필드를 정의하는 데 사용되는 필드를 설명합니다.

권한 부여 필드

기본적으로, 권한 부여 필드는 작업 요청 메시지의 헤더 일부로 구성됩니다. 작업 요청에 추가 권한 부여 필드가 필요하거나 예상되는 권한 부여가 헤더의 일부가 아닌 경우(예: 사회 보장 번호 또는 PIN),

1. + 권한 부여 필드 추가를 클릭한 다음 그림과 같이 필드를 정의합니다.
   
2. 필드 유형 필드에서, 작업 요청 메시지 및 필요한 권한 부여 필드 유형에서 위치에 따라 다음 중 하나를 선택할 수 있습니다. 헤더 – 봇은 요청 헤더의 일부로 권한 부여 필드를 예상합니다.페이로드 – 봇은 요청 본문의 내용 일부로 권한 부여 필드를 예상합니다.쿼리 문자열 – 봇은 요청 본문에서 권한 부여 필드를 쿼리로 예상합니다.경로 매개변수 – 봇은 권한 부여 필드를 요청의 URL 경로의 일부로 예상합니다.
3. 필드 키 필드에서, 선택한 필드 유형에 대한 필드 이름을 입력합니다.
4. 필드 값 필드에 지정된 필드 키의 값을 입력합니다.
5. 추가를 클릭합니다. 새 권한 부여 필드가 권한 부여 필드 섹션에 추가됩니다.
6. 추가 인증 권한 필드를 추가하려면, 권한 부여 필드 섹션에서 추가를 클릭합니다.

테스트

인증을 저장한 후, 새 권한 부여 유형의 권한 부여 확인 URL을 정의한 경우 권한 부여 테스트를 클릭하여 권한 부여 탭에서 권한 부여 정의를 테스트하고 작업의 나머지 단계 개발을 계속 진행할 수 있습니다.


권한 부여 테스트를 클릭한 후, 권한 부여 테스트 창이 표시되고 다음 그림과 같이 권한 부여 확인 URL 섹션에서 지정한 URL로 채워집니다.

API 키를 사용한 권한 부여 테스트 설정 방법

1. 권한 부여 확인 URL 필드에서, 인증 설정을 테스트하려는 URL을 확인하거나 입력합니다.
2. 봇이 하위 도메인을 사용하는 경우, 테넌시 필드가 표시되고 테넌트를 지정해야 합니다.
3. API 키 필드에 애플리케이션의 API 키를 입력합니다.
4. Content-Type 필드에서 URL에 예상되는 콘텐츠 유형을 선택합니다.
5. URL을 테스트하려는 경우, 메소드 필드는 읽기 전용이며 GET으로 설정됩니다.
6. 테스트를 클릭하여 권한 부여 테스트를 시작합니다.

인증 유효성 검증이 완료되면, 권한 부여 테스트 대화 상자가 닫히고 성공 또는 실패 검증 결과가 권한 부여 테스트 버튼 바로 오른쪽에 표시됩니다. 권한 부여가 실패하면, 다음 그림과 같이 헤더 및 응답 탭과 함께 권한 부여 테스트 실패 메시지가 표시됩니다.

こちらで、Kore.aiのバーチャルアシスタントプラットフォームでの通知タスクの設定方法について確認しました。このセクションでは、APIキーを使用した認証の設定方法について見ていきます。

設定

APIキーは、識別のためのユニークな識別子とシークレットトークンの両方の役割を果たすことができ、関連するAPIへのアクセス権利のセットを提供するための認証も可能です。エンドユーザーにアクセスのためのユーザー名とパスワードの両方をプロンプトする代わりに、タスクを調整する際にはAPIキーのみを要求されます。APIキー認証タイプを使用するには、まずは必ずウェブアプリケーションにアカウントを登録し、次にKore.ai認証メカニズムの設定を調整するためのそのアプリケーションのAPIキーを生成してください。下図は、APIキー認証タイプで定義するフィールドです。
APIキー認証を定義するには、

1. 認証タイプフィールドでAPIキーを選択します。次にボットビルダーユーザーインターフェイスに表示される認証の名前を指定します。

テナンシー

必要に応じて、サブドメインセクションで、ウェブアプリケーションにベースURLやユーザーインターフェイスがURLにテナント名を使用する場合、はいを選択してください。例えば、koreは、www.kore.someCompany.comとしてテナントを使用したウェブサービスのテナント組織です。下記の設定の例では、テンナンシーURLは{tenant}組織のプレースホルダが含まれます。

フォームフィールド

デフォルトのユーザー名とパスワードのフィールドがご需要を満たしていない場合、認証フォームのフィールドを追加することで、エンドユーザーに表示される新しいフィールドを追加することができます。認証フォームにフィールドを追加するには、

• ＋フォームフィールドを追加をクリックします。

以下の図とはダイアログへのパスワード フィールドに追加する認証その定義の作例です。 以下のテーブルは認証IDPフォームフィールドの定義に使用するフィールドの説明です。

承認フィールド

デフォルトでは、認証フィールドとはタスクリクエストのメッセージのヘッダーの一部として調整されたものです。もしタスクリクエストには追加の認証フィールドが必須、または予想の認証はのヘッダーの一部ではないの場合、例えば、ソーシャルセキュリティの数字やPIN、

1. +認証フィールドの追加をクリックして、下記の図の通りにフィールドを定義します。
2. フィールドタイプフィールドに、以下のうちの一つを選択することができます： 必須のタスクリクエストメッセージの位置および認証フィールドのタイプの次第です。ヘッダー―Botは、リクエストのヘッダの一部として認証フィールドを予想します。ペイロード―Botは、リクエストの本文のコンテンツの一部として認証フィールドを予想します。クエリ文字列―Botは認証フィールドをリクエストの本文にあるクエリとして予想します。パスパラメータ―Botは、認証フィールドをURLパスリクエストの一部として予想します。
3. フィールドキーフィールドに、選択済のフィールドタイプフィールド名を入力してください。
4. フィールド値フィールドに、フィールドキーの指定された値を入力してください。
5. 追加をクリックします。新規の認証フィールドは認証フィールドのセクションに追加されました。
6. 認証フィールドを追加する場合、認証フィールドセクションの追加をクリックしてください。

テスト

認証を保存した後、もし新規の認証タイプに認証チェックURLが定義済の場合、認証タブで認証の定義をテストできます、テスト認証をクリックしてからとタスクの残るステップの開発を続いてください。 テスト認証をクリックすると、下記の図の通りに、テスト認証ダイアログは表示され、そして認証チェックURLセクションにご指定のURLが発生します。 テスト認証の調整―APIキー

1. 認証チェックURLフィールドに、実証やURLをテスト認証調整に入力してください。
2. Botはサブドメインを使用する場合、テンナンシーフィールドは表示されて、必ずテナントを指定してください。
3. [API キー] フィールドでアプリケーションの API キーを入力します。
4. URL として求めるコンテンツ タイプは、 [コンテンツ タイプ] フィールドで選択します。
5. URLのテストの場合、方法フィールドはリードオンリーそしてGETと設定されました。
6. テストをクリックすると認証テストを開始します。

認証の検証が完成の場合、テスト認証のダイアログが閉じて、その検証の結果、成功や失敗は即刻、テスト認証のボタンに表示します。認証失敗の場合、下記の図の通りに、認証テスト失敗のメッセージはヘッダーおよび応答のタブとともに表示します。

We have seen how an Alert task can be set up in Kore.ai virtual assistant platform here. In this section, we will see how the authorization can be set up using API Key.

Setting Up

An API key can act as both a unique identifier and a secret token for identification as well as authentication to provide a set of access rights on the associated API. Instead of prompting the end-user for both a username and password for access, the user is prompted only for an API key when configuring the task. To use the API Key Authorization Type, you must first register an account with the web application and then generate an API Key for that application to configure the settings for the Kore.ai authorization mechanism.The following illustration shows the fields to define for the API Key Authorization Type.

To define an API key authorization,

1. Select API Key in the Authorization Type field. Then specify a Name for the authorization to be displayed in the Bot builder user interface.

Tenancy

If required, in the Subdomain section, select Yes if the base URL for a web application or user interface the uses a tenant name in the URL. For example, kore is the tenant organization for a web service using tenants as www.kore.someCompany.com.
In the following example configuration, the tenancy URL contains the {tenant} organization placeholder.

Form Fields

If the default username and password fields do not meet your needs, you can add new fields displayed to the end-user by adding authorization form fields. To add fields on the authorization form,

• Click+ Add Form Field.

The following illustration is an example of a definition to add a password field to the authorization dialog.

The following table describes the fields used to define an authorization IDP form field.

Authorization Fields

By default, authorization fields are configured as part of the header of the task request message. If your task request requires additional authorization fields or the expected authorization is not part of the header, for example, social security number or PIN,

1. Click + Add Authorization Field and then define the fields as shown in the following illustration.
   
2. In the Field Type field, you can select one of the following depending on where in the task request message and the type of authorization fields that are required.
   Header – The Bot expects the authorization fields as part of the header of the request.Payload – The Bot expects the authorization fields as part of the content of the body of the request.Query String – The Bot expects the authorization fields as a query in the body of the request.Path Param – The Bot expects the authorization fields as part of the URL path for the request.
3. In the Field Key field, enter the name of the field for the selected Field Type.
4. In the Field Value field, enter the value for the Field Key specified.
5. Click Add. The new authorization field is added in the Authorization Fields section.
6. To add additional authorization fields, click Add in the Authorization Fields section.

Testing

After you save the authentication, if you defined an Authorization Check URL for your new authorization type, you can test your authorization definition on the Authentication tab when you click Test Authorization before continuing to develop the remaining steps of your task.

After you click Test Authorization, the Test Authorization window is displayed and populated with the URL you specified in the Authorization Check URL section, as shown in the following illustration.

To configure the Test Authorization – API Key

1. In the Auth Check URL field, verify or enter the URL to test the authentication configuration.
2. If your bot uses subdomains, the Tenancy field is displayed and you must specify the tenant.
3. Enter the API key for the application in the API Key field.
4. Select the content type expected for the URL in the Content-Type field.
5. For testing the URL, the Method field is read-only and set to GET.
6. Click Test to begin the authorization test.

When the validation of authentication is complete, the Test Authorization dialog is closed and the results of the validation, either success or failure, are displayed to the immediate right of the Test Authorization button. If the authorization fails, the Auth Test Failed message is displayed along with the Headers and Response tabs as shown in the following illustration.