OAuthクライアントを作成する


近日公開予定の機能

OAuthクライアントを使用すると、Platform APIにリクエストをPureCloudたり、 PureCloudに対して認証したりできます。

前提条件
  • OAuth > ; クライアント > ; 追加する 許可

この手順は、のためにあるアプリケーションそのアプリは、それはへのリクエスト加えることができ、トークンを受信したいプロバイダPureCloud プラットフォーム API。トークンは、PureCloudデータにアクセスするためのアプリに対するユーザーの許可を表します。アプリがAPIエンドポイントへのリクエストを承認する必要がある場合に使用されます。PureCloud プラットフォーム APIのリストを見るには、 APIリソース PureCloud 開発者センター 。

  1. [管理] をクリック
  2. 統合クリック OAuth
  3. クリック クライアントを追加。[クライアントの詳細]タブが表示されます。

  4. セット アプリ名 アプリのわかりやすい名前に。これは誰かが見たときに表示される名前です 承認する このOAuthクライアント。
  5. (省略可能)にアプリの簡単な説明を入力します。 説明 ボックス。
  6. 次に、このクライアントで作成されたトークンが期限切れになるまでの期間を設定します。デフォルトの期間を受け入れるか、300から172800秒の間の値を入力します。これにより、トークンの有効期間が最大2日以内に設定されます。
  7. 下から選択してください 交付金の種類。付与タイプは、アプリケーションがアクセストークンを取得する方法を設定します。 PureCloudは、以下にリストされているOAuth 2許可付与タイプをサポートします。付与タイプの名前をクリックすると、付与タイプに関する詳細情報が表示されます。 the PureCloud開発者センター。

    • クライアント資格情報の付与:非ユーザーアプリケーション専用のシングルステップ認証プロセス(Windowsサービスやcronジョブなど)。クライアントアプリケーションは、アクセストークンと引き換えにOAuthクライアントの認証情報を提供します。この認証タイプはユーザーのコンテキストにはないため、ユーザー固有のAPI(例:GET / v2 / users / me)にアクセスすることはできません。

      SalesforceにPureCloudの役割を割り当てる場合は、以下も参照してください。 Salesforceに対するPureCloudのOAuthクライアント権限

    • コード許可付与:ユーザーがPureCloudで認証してからクライアントアプリケーションに認証コードが返される2段階認証プロセス。クライアントアプリケーションはOAuthクライアントの認証情報を提供し、認証コードを使用してアクセストークンを取得します。認証されたAPI呼び出しを行うときにアクセストークンを使用できます。これは、最も安全なオプションであり、API要求がサーバー側で行われるWebサイト(ASP.NETやPHPなど)や、シンクライアントがユーザーを認証して認証コードをバックエンドサーバーに渡すデスクトップアプリケーションに最適です認証トークンと交換してAPI要求を行う。

    • トークンの暗黙の付与(ブラウザ):ユーザーがPureCloudで認証し、クライアントアプリケーションに直接アクセストークンが返されるシングルステップ認証プロセス。このオプションは、認証コードの付与よりもアクセストークンのセキュリティが低くなりますが、クライアントサイドのブラウザアプリケーション(JavaScriptなど)およびほとんどのデスクトップアプリケーション(例:NET WPF / WinFormsまたはJavaデスクトッププログラム)

    • SAM2ベアラ:クライアントアプリケーションがベアラトークンを要求するためにSecurity Assertion Markup Language ( SAML )(SAML2)アサーションを使用することができる認証プロセス。また見なさい: PureCloudシングルサインオンおよびIDプロバイダソリューション

  8. 付与タイプに必要なパラメータを指定します。

    • 役割:選択した場合 クライアント資格情報、 クリック 役割 タブ。これにより、選択可能な役割のリストが開きます。OAuthクライアント統合でできることを決定するために、最低限の役割セットを割り当てます。

      また、各役割を部門に関連付ける必要があります。Client Credential Grantの役割にどの部門を関連付けるべきかを決定します。すべてのClient Credential付与役割は、デフォルトでHome Divisionにスコープされています。これらの補助金を使用するアプリケーションおよびシステムが適切なデータにアクセスできるように、適切な部門に更新してください。クライアント資格情報の付与が3人目の相手 or 参加者によって提供されている場合は、3人目の相手 or 参加者に連絡して、付与の使用方法を理解し、役割の部門を適切に更新します。他の付与タイプがアクセス制御の影響を受けることはありません。

    • 許可されたリダイレクトURI( 回線ごとに1つ、最大125): これらは、後続のAPI呼び出しを認証するために後で使用されるアクセストークンと交換するために、許可コードがポストされるURIです。

    • 範囲クライアント資格情報を除くすべての許可の種類には、スコープ設定があります。[スコープ]ボックスをクリックして、アプリで利用可能なスコープの一覧を表示します。ベストプラクティスとして、アプリに必要な最小限の範囲のみを選択してください。スコープについては、 OAuthスコープ デベロッパーセンターで。

  9. 保存するをクリックします。PureCloudは、クライアントIDとクライアントシークレット(トークン)を作成します。

PureCloud OAuthクライアントを使用する準備が整いました。

前提条件
  • OAuth > ; クライアント > ; 追加する 許可

いずれかの状況が当てはまる場合、 PureCloud Embeddable Framework OAuthクライアントを作成します。

  • パブリック展開を実装しています。
  • アクセスするプライベート展開を実装しています getAuthToken framework.jsファイルのメソッド。詳細については、 User.getAuthToken デベロッパーセンターで。

OAuthクライアントは、開発者が使用できるクライアントIDを生成します clientIds framework.jsファイル内。詳細については、 clientIds デベロッパーセンターで。

  1. [管理] をクリック
  2. 統合クリック OAuth
  3. クリック クライアントを追加。[クライアントの詳細]タブが表示されます。

    画像をクリックして拡大します。

    OAuthクライアントのクライアント詳細タブ

  4. セット アプリ名 アプリのわかりやすい名前に。

    アプリ名は、誰かが 認可する このOAuthクライアント。

  5. (省略可能)にアプリの簡単な説明を入力します。 説明 ボックス。
  6. このクライアントで作成されたトークンの有効期限が切れるまでの期間を設定します。

    デフォルトの期間を受け入れるか、300から172800秒の間の値を入力します。この期間は、トークンの存続期間を最大2日以下に設定します。

    先端Genesys トークン期間を 18 時間 (64800 秒) に設定することをお勧めします。通常、この期間は、トークンがエージェントの通常の稼働日外に期限切れになります。

  7. 助成金の種類、 選択する トークンの暗黙的付与(ブラウザ)

    詳細については、 認可 そして OAuth Grant –暗黙的 デベロッパーセンターで。

  8. 許可されたリダイレクトURI、 追加 http:// apps。mypurecloud.com/crm/index.html.

    注意:後Genesys 、あなたの一般公開を発行し、 Genesys使用する新しいURIを提供します。

  9. [ スコープ で、必要なすべてのスコープを追加します。スコープを追加することもできます。

    必要なスコープの一覧については、「 PureCloud 埋め込みクライアントの 管理者の要件 を参照してください。スコープについては、 OAuthスコープ デベロッパーセンターで。

  10. 保存するをクリックします。

    PureCloudは、クライアントIDとクライアントシークレット(トークン)を作成します。

  11. 開発者に クライアントID

    開発者は、クライアントIDを追加する必要があります clientIds framework.jsファイル内。詳細については、 clientIds デベロッパーセンターで。

統合の詳細については、 PureCloud Embeddable Frameworkについて