با OAuth احراز هویت

OAuth به نمایندگان اجازه می دهد تا هویت کاربران را تأیید کنند و اطلاعات شخصی شده را در مکالمات به روشی امن ارائه دهند. با وارد کردن کاربران به یک ارائه‌دهنده OAuth قابل اعتماد، نمایندگان می‌توانند به داده‌های کاربر دسترسی داشته باشند که می‌تواند به ارائه پاسخ‌های سریع از طریق اتوماسیون و صرفه‌جویی در زمان برای نمایندگان زنده کمک کند.

Business Messages از OAuth 2.0 با پیشنهاد درخواست احراز هویت پشتیبانی می‌کند، که از کاربران می‌خواهد وارد یک ارائه‌دهنده OAuth شوند که شما برای نماینده پیکربندی کرده‌اید. پس از اینکه کاربر با موفقیت وارد سیستم شد، Business Messages یک کد مجوز را به عنوان پیام به نماینده ارسال می کند.

پس از دریافت کد مجوز از ارائه‌دهنده OAuth، می‌توانید با APIهای آن‌ها ادغام کنید و از جریان‌های مکالمه‌ای که به اطلاعات هویت کاربر نیاز دارند پشتیبانی کنید. به خاطر داشته باشید که هر سرویسی که با آن تعامل دارید شرایط استفاده خاص خود را دارد.

OAuth را برای یک نماینده پیکربندی کنید

برای فعال کردن پیشنهاد درخواست احراز هویت برای یک نماینده، ابتدا باید OAuth را پیکربندی کنید.

برای تعیین یک پیکربندی OAuth، یک درخواست PATCH با Business Communications API برای به روز رسانی قسمت endpointUrl عامل ایجاد می کنید.

بعد از اینکه URL نقطه پایانی را مشخص کردید، باید URI های تغییر مسیر را برای نماینده خود ذخیره کنید و URI های تغییر مسیر را در اطلاعات ارائه دهنده OAuth خود به روز کنید.

پیش نیازها

شما به موارد زیر نیاز دارید:

  • ارائه دهنده OAuth که از مشخصات OAuth 2.0 پیروی می کند
  • مسیر کلید حساب سرویس پروژه GCP شما در ماشین توسعه شما

  • name نماینده (به عنوان مثال، "brands/12345/agents/67890")

    اگر name نماینده را نمی‌دانید، فهرست همه نمایندگی‌های یک برند را ببینید.

  • نشانی وب نقطه پایانی که در آن کاربران وارد ارائه‌دهنده OAuth می‌شوند

درخواست به روز رسانی را ارسال کنید

برای به روز رسانی عامل، دستور زیر را اجرا کنید. متغیرها را با مقادیری که در پیش نیازها شناسایی کرده اید جایگزین کنید.

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/brands/BRAND_ID/agents/AGENT_ID?updateMask=businessMessagesAgent.authorizationConfig" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-communications" \
-H "$(oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY businesscommunications)" \
-d "{
    'businessMessagesAgent': {
        'authorizationConfig': {
            'endpointUrl': 'ENDPOINT_URL',
        },
    },
}"

URI های تغییر مسیر را به روز کنید

اکنون که OAuth برای عامل پیکربندی شده است، باید چهار URI تغییر مسیر را به ارائه دهنده OAuth خود اضافه کنید:

  • https://business.google.com/callback
  • https://business.google.com/callback?
  • https://business.google.com/message?az-intent-type=1
  • https://business.google.com/message?az-intent-type=1&

شما باید همه URL های تغییر مسیر را در اطلاعات ارائه دهنده OAuth خود بگنجانید.

روند به روز رسانی URI های تغییر مسیر براساس ارائه دهنده OAuth متفاوت است. برای دستورالعمل ها به ارائه دهنده OAuth خود مراجعه کنید.

اکنون که OAuth برای نماینده شما پیکربندی شده است، می توانید با پیشنهاد درخواست احراز هویت، کاربران را احراز هویت کنید.

احراز هویت یک کاربر

پس از پیکربندی OAuth برای یک نماینده، می‌توانید از کاربران بخواهید با پیشنهاد درخواست احراز هویت وارد سیستم شوند.

پیش نیازها

شما به موارد زیر نیاز دارید:

  • مسیر کلید حساب سرویس پروژه GCP شما در ماشین توسعه شما

  • name نماینده (به عنوان مثال، "brands/12345/agents/67890")

    اگر name نماینده را نمی‌دانید، فهرست همه نمایندگی‌های یک برند را ببینید.

  • شناسه مشتری از ارائه‌دهنده OAuth شما

  • الزامات چالش کد از ارائه دهنده OAuth شما

  • دامنه ها از ارائه دهنده OAuth شما

پیشنهاد درخواست احراز هویت را ارسال کنید

پیشنهاد درخواست احراز هویت

برای احراز هویت یک کاربر،

  1. برای درخواست OAuth، تأیید کننده کد و رشته های چالش کد را ایجاد کنید. برای شرایط و گزینه ها به ارائه دهنده OAuth خود مراجعه کنید.
  2. پیامی با پیشنهاد درخواست احراز هویت ارسال کنید.

حلقه

# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

#     https://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# This code sends a text message to the user with an authentication request suggestion
# that allows the user to authenticate with OAuth. It also has a fallback text.
# Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/message/send?hl=en#authentication-request-suggestion

# Replace the __CONVERSATION_ID__ with a conversation id that you can send messages to
# Make sure a service account key file exists at ./service_account_key.json
# Replace the __CLIENT_ID__
# Replace the __CODE_CHALLENGE__
# Replace the __SCOPE__

curl -X POST "https://businessmessages.googleapis.com/v1/conversations/__CONVERSATION_ID__/messages" \
-H "Content-Type: application/json" \
-H "User-Agent: curl/business-messages" \
-H "$(oauth2l header --json ./service_account_key.json businessmessages)" \
-d "{
    'messageId': '$(uuidgen)',
    'text': 'Sign in to continue the conversation.',
    'fallback': 'Visit support.growingtreebank.com to continue.',
    'suggestions': [
      {
        'authenticationRequest': {
          'oauth': {
            'clientId': '__CLIENT_ID__',
            'codeChallenge': '__CODE_CHALLENGE__',
            'scopes': [
              '__SCOPE__',
            ],
          },
        },
      },
    ],
    'representative': {
      'avatarImage': 'https://developers.google.com/identity/images/g-logo.png',
      'displayName': 'Chatbot',
      'representativeType': 'BOT'
    }
  }"
send-message-authentication-request-suggestion.sh

Node.js


/**
 * This code sends a text message to the user with an authentication request suggestion
 * that allows the user to authenticate with OAuth. It also has a fallback text.
 * Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/message/send?hl=en#authentication-request-suggestion
 *
 * This code is based on the https://github.com/google-business-communications/nodejs-businessmessages Node.js
 * Business Messages client library.
 */

/**
 * Before continuing, learn more about the prerequisites for authenticating
 * with OAuth at: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/oauth?hl=en
 *
 * Edit the values below:
 */
const PATH_TO_SERVICE_ACCOUNT_KEY = './service_account_key.json';
const CONVERSATION_ID = 'EDIT_HERE';
const OAUTH_CLIENT_ID = 'EDIT_HERE';
const OAUTH_CODE_CHALLENGE = 'EDIT_HERE';
const OAUTH_SCOPE = 'EDIT_HERE';

const businessmessages = require('businessmessages');
const uuidv4 = require('uuid').v4;
const {google} = require('googleapis');

// Initialize the Business Messages API
const bmApi = new businessmessages.businessmessages_v1.Businessmessages({});

// Set the scope that we need for the Business Messages API
const scopes = [
  'https://www.googleapis.com/auth/businessmessages',
];

// Set the private key to the service account file
const privatekey = require(PATH_TO_SERVICE_ACCOUNT_KEY);

/**
 * Posts a message to the Business Messages API along with an authentication request.
 *
 * @param {string} conversationId The unique id for this user and agent.
 * @param {string} representativeType A value of BOT or HUMAN.
 */
async function sendMessage(conversationId, representativeType) {
  const authClient = await initCredentials();

  if (authClient) {
    // Create the payload for sending a message along with an authentication request
    const apiParams = {
      auth: authClient,
      parent: 'conversations/' + conversationId,
      resource: {
        messageId: uuidv4(),
        representative: {
          representativeType: representativeType,
        },
        fallback: 'Visit support.growingtreebank.com to continue.',
        text: 'Sign in to continue the conversation.',
        suggestions: [
          {
            authenticationRequest: {
              oauth: {
                clientId: OAUTH_CLIENT_ID,
                codeChallenge: OAUTH_CODE_CHALLENGE,
                scopes: [OAUTH_SCOPE]
              }
            }
          },
        ],
      },
    };

    // Call the message create function using the
    // Business Messages client library
    bmApi.conversations.messages.create(apiParams,
      {auth: authClient}, (err, response) => {
      console.log(err);
      console.log(response);
    });
  }
  else {
    console.log('Authentication failure.');
  }
}

/**
 * Initializes the Google credentials for calling the
 * Business Messages API.
 */
 async function initCredentials() {
  // configure a JWT auth client
  const authClient = new google.auth.JWT(
    privatekey.client_email,
    null,
    privatekey.private_key,
    scopes,
  );

  return new Promise(function(resolve, reject) {
    // authenticate request
    authClient.authorize(function(err, tokens) {
      if (err) {
        reject(false);
      } else {
        resolve(authClient);
      }
    });
  });
}

sendMessage(CONVERSATION_ID, 'BOT');
send-message-authentication-request-suggestion.js

پایتون


"""Sends a text message to the user with an authentication request suggestion.

It allows the user to authenticate with OAuth and has a fallback text.
Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/message/send?hl=en#authentication-request-suggestion

This code is based on the https://github.com/google-business-communications/python-businessmessages
Python Business Messages client library.
"""

import uuid

from businessmessages import businessmessages_v1_client as bm_client
from businessmessages.businessmessages_v1_messages import BusinessMessagesAuthenticationRequest
from businessmessages.businessmessages_v1_messages import BusinessMessagesAuthenticationRequestOauth
from businessmessages.businessmessages_v1_messages import BusinessmessagesConversationsMessagesCreateRequest
from businessmessages.businessmessages_v1_messages import BusinessMessagesMessage
from businessmessages.businessmessages_v1_messages import BusinessMessagesRepresentative
from businessmessages.businessmessages_v1_messages import BusinessMessagesSuggestion
from oauth2client.service_account import ServiceAccountCredentials

# Before continuing, learn more about the prerequisites for authenticating
# with OAuth at: https://developers.google.com/business-communications/business-messages/guides/how-to/integrate/oauth?hl=en

# Edit the values below:
path_to_service_account_key = './service_account_key.json'
conversation_id = 'EDIT_HERE'
oauth_client_id = 'EDIT_HERE'
oauth_code_challenge = 'EDIT_HERE'
oauth_scope = 'EDIT_HERE'

credentials = ServiceAccountCredentials.from_json_keyfile_name(
    path_to_service_account_key,
    scopes=['https://www.googleapis.com/auth/businessmessages'])

client = bm_client.BusinessmessagesV1(credentials=credentials)

representative_type_as_string = 'BOT'
if representative_type_as_string == 'BOT':
  representative_type = BusinessMessagesRepresentative.RepresentativeTypeValueValuesEnum.BOT
else:
  representative_type = BusinessMessagesRepresentative.RepresentativeTypeValueValuesEnum.HUMAN

# Create a text message with an authentication request
message = BusinessMessagesMessage(
    messageId=str(uuid.uuid4().int),
    representative=BusinessMessagesRepresentative(
        representativeType=representative_type
    ),
    text='Sign in to continue the conversation.',
    fallback='Visit support.growingtreebank.com to continue.',
    suggestions=[
        BusinessMessagesSuggestion(
            authenticationRequest=BusinessMessagesAuthenticationRequest(
                oauth=BusinessMessagesAuthenticationRequestOauth(
                    clientId=oauth_client_id,
                    codeChallenge=oauth_code_challenge,
                    scopes=[oauth_scope])
                )
            ),
        ]
    )

# Create the message request
create_request = BusinessmessagesConversationsMessagesCreateRequest(
    businessMessagesMessage=message,
    parent='conversations/' + conversation_id)

# Send the message
bm_client.BusinessmessagesV1.ConversationsMessagesService(
    client=client).Create(request=create_request)
send-message-authentication-request-suggestion.py
  1. هنگامی که کاربر روی پیشنهاد ضربه می زند و با موفقیت وارد سیستم می شود، پیامی در وب هوک نماینده خود دریافت می کنید. کد مجوز را از قسمت authenticationResponse.code بازیابی کنید.

پس از دریافت پیام، می‌توانید کد مجوز و تأییدکننده کد را با یک نشانه دسترسی از ارائه‌دهنده OAuth خود مبادله کنید. با رمز دسترسی می توانید به داده های کاربر دسترسی داشته باشید.

برای نمونه گفتگو با احراز هویت، از جمله نمونه کد، به تأیید هویت کاربر مراجعه کنید.