Cómo utilizar el tipo de credencial definido por el usuario (OAuth)

Nota: Este artículo se aplica a la integración de acciones datos de servicios web.

Al agregar la integración de acciones datos de servicios web, puede seleccionar un tipo de credencial: Autenticación básica, Definido por el usuario o Definido por el usuario (OAuth). Para obtener más información, consulte Añadir una integración de acciones de datos y Tipos de credenciales.

Este artículo explica cómo utilizar el tipo de credencial Definido por el usuario (OAuth). Para obtener más información, consulte Flujo de trabajo para tipo de credencial definido por el usuario (OAuth).

  1. Cuando añada la integración, configure las credenciales definidas por el usuario (OAuth).

    Agregue nombres de campo usados por su servicio web y valores para estos nombres de campo.

    Configurar credenciales para definido por el usuario (OAuth)

    La integración crea una acción de autenticación personalizada que devuelve un autenticación respuesta.

  2. Configure la acción de autenticación personalizada con la información necesaria para autenticarse con la definición punto final.

    La integración hace que estos nombres de campo y valores estén disponibles para su uso en acciones personalizadas posteriores. Los valores autenticación respuesta son accesibles en el Respuesta Contexto de velocidad.

    Para configurar la acción de autorización, siga estos pasos:

    1. Abra la acción de autenticación personalizada.

      Puede acceder a la acción de autenticación personalizada de dos maneras:

      • En la página Credenciales de la acción, haga clic en Acción de autorización personalizada.
      • En la página Acciones, haga clic en la acción de autenticación personalizada para su integración. Para obtener más información, consulte Gestionar acciones.
    2. Haga clic en el botón Configuración tab.
    3. Haga clic en el botón Configuración tab.

      La solicitud de la acción de autenticación personalizada incluye información de autorización. En el ejemplo siguiente, la autorización se incluye en los encabezados. credenciales es una palabra clave estática. url de registro, Id, y clientSecreto son los nombres de campo añadidos a la configuración de credenciales.

      Advertencia: Asegúrese de escapar de cualquier uso de variables de entrada o salida en solicitarPlantilla, sucesiónPlaca, o solicitarPlantilla de emergencia. Si no tiene correctamente variables de escape con caracteres especiales, las acciones de datos fallarán en la ejecución.
      • Uso Cadena esc.jsonString para escapar de las cuerdas dentro de los cuerpos JSON.

        Para obtener más información, consulte la sección esc.jsonString en Macros Velocity para acciones de datos.

      • Uso esc.url() o urlTool.optionalQueryParam() para escapar correctamente de la ruta o de los parámetros de consulta de un solicitarPlantilla de emergencia o solicitarPlantilla si se utiliza x-www.form-urlencoded valores.

        Para obtener más información, consulte la sección de escape de cadena biblioteca en Macros Velocity para acciones de datos.

      Debido a que el escaparate es específico del contexto de JSON, el siguiente ejemplo no muestra de forma intencionada escapar.

      {
        "requestUrlTemplate": "${credentials.loginUrl}",
        "requestType": "POST",
        "headers": {
          "Authorization": "Basic $encoding.base64(\"${credentials.clientId}:${credentials.clientSecret}\")",
          "Content-Type": "application/x-www-form-urlencoded"
        },
        "requestTemplate": "grant_type=client_credentials"
      }
      
    4. Haga clic en el botón Prueba tab.
    5. Haga clic Ejecutar acción.

      La integración ejecuta la acción de autenticación personalizada y genera lo que devuelve el servicio web (con valores editados). En el ejemplo siguiente, el servicio web vuelve token_de_acceso para Id, , tipo_token para clientSecreto, y caduca_en

      {
        "access_token": "<redacted string(86)>",
        "token_type": "<redacted string(6)>",
        "expires_in": "<redacted number>"
      }
  3. Utilice la autenticación respuesta que devuelve el servicio web en las solicitudes de todas las acciones personalizadas que cree. 

    El siguiente ejemplo es una solicitud de una acción personalizada llamada Get Presence (Obtener presencia). El encabezado de la solicitud de acción personalizada incluye la autorización. Respuesta es una palabra clave estática. tipo_token y token_de_acceso son los valores devueltos del servicio web. Para obtener más información, consulte Crear una acción personalizada, , Añadir configuración a acciones personalizadas, y Solicitar configuración.

    {
      "requestUrlTemplate": "https://api.mypurecloud.com/api/v2/users/${input.USER_ID}/presences/PURECLOUD",
      "requestType": "GET",
      "headers": {
        "Authorization": "${authResponse.token_type} ${authResponse.access_token}",
      },
      "requestTemplate": "${input.rawRequest}"
    }
    Nota: Al probar una acción personalizada, la integración redactará cualquier información de autorización. Para obtener más información, consulte Probar una acción personalizada.

Para obtener más información sobre la integración, consulte Acerca de la integración de acciones datos de servicios web.