Autenticarsi con OAuth

OAuth consente agli agenti di verificare l'identità degli utenti identità e di fornire servizi le informazioni nelle conversazioni in modo sicuro. Facendo accedere gli utenti a un provider OAuth affidabile, gli agenti possono accedere ai dati degli utenti e fornire le risposte attraverso l'automazione e risparmiare tempo per gli operatori.

Business Messages supporta OAuth 2.0 con la richiesta di autenticazione suggerimento, che richiede agli utenti di accedere a un provider OAuth che hai configurato per l'agente. Dopo che l'utente ha eseguito l'accesso, Business Messages passa un'autorizzazione all'agente sotto forma di messaggio.

Una volta ricevuto il codice di autorizzazione dal provider OAuth, puoi integrarsi con le proprie API e supportare i flussi di conversazione che richiedono informazioni sull'identità. Ricorda che ogni servizio con cui interagisci ha il suo termini e condizioni d'uso propri.

Configurare OAuth per un agente

Per attivare il suggerimento relativo alla richiesta di autenticazione per un agente, devi: devi prima configurare OAuth.

Per specificare una configurazione OAuth, effettua una richiesta PATCH con Business Communications dell'API per aggiornare il campo endpointUrl dell'agente.

Dopo aver specificato l'URL dell'endpoint, devi archiviare gli URI di reindirizzamento per e aggiornare gli URI di reindirizzamento nelle informazioni del provider OAuth.

Prerequisiti

Ti occorrono i seguenti elementi:

• Un provider OAuth conforme alla specifica OAuth 2.0.
• Percorso della chiave dell'account di servizio del progetto Google Cloud sulla macchina di sviluppo

• L'agente name (ad es. "brands/12345/agents/67890")

  Se non conosci il name dell'agente, consulta Elenca tutti gli agenti per un brand.

• L'URL dell'endpoint da cui gli utenti accedono al provider OAuth

Invia la richiesta di aggiornamento

Per aggiornare l'agente, esegui questo comando. Sostituisci le variabili con i valori che hai identificato nella sezione Prerequisiti.

Nota: non puoi aggiornare la configurazione dell'autorizzazione di un agente dopo che è stato verificati. Se devi aggiornare la configurazione di un agente verificato, contattaci. Devi prima firmare con un Account Google Business Messages. Per creare un account, consulta Registrati presso l'attività Messaggi.

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',
        },
    },
}"

Aggiorna URI di reindirizzamento

Ora che OAuth è configurato per l'agente, devi aggiungere quattro URI di reindirizzamento al provider 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&

Devi includere tutti gli URL di reindirizzamento nelle informazioni del provider OAuth.

La procedura per aggiornare gli URI di reindirizzamento varia a seconda del provider OAuth. Consulta le Provider OAuth per istruzioni.

Ora che OAuth è configurato per l'agente, puoi eseguire l'autenticazione utenti con la richiesta di autenticazione suggerimento.

Autenticare un utente

Dopo aver configurato OAuth per un agente, puoi chiedere agli utenti di accedere con Richiesta di autenticazione suggerimento.

Prerequisiti

Ti occorrono i seguenti elementi:

• Percorso della chiave dell'account di servizio del progetto Google Cloud sulla macchina di sviluppo

• L'agente name (ad es. "brands/12345/agents/67890")

  Se non conosci il name dell'agente, consulta Elenca tutti gli agenti per un brand.

• ID client del provider OAuth

• Requisiti della verifica del codice del provider OAuth

• Ambiti del provider OAuth

Invia il suggerimento per la richiesta di autenticazione

Per autenticare un utente,

1. Genera lo strumento di verifica del codice e le stringhe di verifica del codice per la richiesta OAuth. Per requisiti e opzioni, rivolgiti al tuo provider OAuth.
2. Invia un messaggio con il suggerimento Richiesta di autenticazione.

cURL

# 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

Python

"""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. Quando l'utente tocca il suggerimento ed esegue l'accesso, ricevi un nel webhook dell'agente. Recupera il codice di autorizzazione dal campo authenticationResponse.code.

Una volta ricevuto il messaggio, puoi scambiare il codice e il codice di autorizzazione strumento di verifica per ottenere un token di accesso dal provider OAuth. Puoi accedere ai dati utente con il token di accesso.

Per una conversazione di esempio con l'autenticazione, inclusi esempi di codice, consulta Autentica il utente.