Tarea Leer registro de Salesforce

Existen dos tipos de tareas disponibles en la integración de Apigee: tareas principales y tareas de conector. La tarea Leer registro de Salesforce es una tarea de conector que te permite leer un objeto de Salesforce existente en tu instancia de Salesforce.

Antes de comenzar

En esta sección, se describen los pasos necesarios para conectar y configurar una instancia de Salesforce a fin de usar los eventos de Captura de datos modificados (CDC) o Platform para transmitir los cambios a tu Integración de Apigee en forma de Pub/Sub. Los siguientes pasos deben completarse antes de configurar cualquier tarea o activador relacionado con Salesforce en la Integración de Apigee:

Configura un usuario de integración

Para configurar un usuario de integración, sigue estos pasos:

  1. Accede a la instancia de Salesforce con tus credenciales de sysadmin.
  2. Haz clic en el ícono de ajustes y selecciona Setup, como se muestra en la siguiente imagen: alt_text
  3. Haz clic en Users > Users en el menú de administración.
  4. En el panel Users, selecciona el botón New User.
  5. En el cuadro de diálogo User Edit, completa los siguientes detalles:
    1. First Name: el nombre del usuario de integración.
    2. Last Name: el apellido del usuario de integración.
    3. Email Address: el correo electrónico del usuario de integración. Lo ideal es que debería ser un correo electrónico de grupo.
    4. Username: el nombre de usuario que cumple con las convenciones de nombres a nivel de la organización.

      Si creas un usuario de integración nuevo, usa el siguiente formato: EMAIL.SALESFORCE_ORG_NAME.SANDBOX_NAME

      Si tienes un usuario de integración existente, confirma que el nombre de usuario se ingrese aquí.

    5. Role: selecciona una de las opciones del menú desplegable.
    6. User License: ingresa Salesforce o, si usas una organización de prueba, ingresa Salesforce Platform.
    7. Profile: selecciona el perfil de permisos para los usuarios de integración en el menú desplegable.

      Recomendamos asignar un perfil sin permisos para proteger el acceso de Salesforce del usuario de integración contra el uso no autorizado.

    8. Haz clic en Guardar.
  6. Para actualizar la contraseña del usuario de integración nuevo, sigue estos pasos:
    1. Haz clic en el botón Reset password(s) en el panel Users. Se envía un correo electrónico de restablecimiento de contraseña a la dirección de correo electrónico asociada con el usuario.
    2. Sigue el flujo de restablecimiento de contraseña desde la cuenta de correo electrónico. Toma nota de la contraseña nueva, ya que la necesitarás para un paso posterior.

Configura un conjunto de permisos

Si ya tienes acceso a un conjunto de permisos que es apropiado para un usuario de integración, puedes omitir este paso y continuar con Configura un token de seguridad. De lo contrario, sigue estos pasos a fin de configurar un conjunto de permisos para el usuario de integración y el objeto de Salesforce.

Si deseas configurar un conjunto de permisos para el usuario de integración, haz lo siguiente:

  1. En el menú Setup, haz clic en Users > Permission Sets.
  2. En el panel Permission Sets, haz clic en el botón New.
  3. En el cuadro de diálogo Permission Sets, ingresa los siguientes detalles:
    • Label: ingresa un nombre para el conjunto de permisos.
    • License: selecciona Salesforce en el menú desplegable License.
    • Haz clic en Guardar.
  4. En la lista de opciones de configuración de System, desplázate hacia abajo y selecciona System Permissions.
  5. En la página System Permissions, haz clic en el botón Edit.
  6. Desplázate hacia abajo en la lista de permisos disponibles y selecciona la casilla de verificación API Enabled.

    También se requiere el permiso Solo usuario de API, pero no se puede habilitar hasta que se restablezca el token de seguridad requerido. Este permiso se agrega en un paso posterior.

  7. (Opcional) Desplázate y selecciona Modify All Data y View All Data, si corresponde. Estos permisos no son obligatorios, pero pueden ser útiles si quieres otorgar automáticamente al usuario de integración acceso a objetos nuevos. Recomendamos habilitar estos permisos solo para realizar pruebas en una zona de pruebas.
  8. Desplázate hasta la parte superior de la lista de permisos y haz clic en Save.
  9. Confirma la configuración y haz clic en Save.

Para configurar el conjunto de permisos para el objeto de Salesforce, haz lo siguiente:

  1. Haz clic en Permission Set Overview para volver a la página de configuración principal Permissions Set.
  2. Selecciona Object Settings en la sección Apps del panel Permissions Set.
  3. Desplázate hacia abajo y selecciona los objetos de Salesforce que requieran un conjunto de permisos. En este ejemplo, se usa el objeto Opportunity.
  4. Haz clic en el botón Edit en la página de detalles del objeto.
  5. Selecciona las casillas de verificación para los tipos de registros. Si sabes qué tipos de registros son obligatorios, selecciónalos. Si no sabes qué tipos de registros son obligatorios, selecciónalos todos.
  6. Selecciona las casillas de verificación de los Permisos de objetos que deseas habilitar. Se recomiendan las opciones Read y Ver todo.
  7. Para otorgar Acceso de lectura o Acceso de edición a cada campo de objeto, selecciona la casilla de verificación correspondiente.
  8. Desplázate hasta el final de la página y haz clic en Guardar.

Configura un token de seguridad

Si ya creaste un token de seguridad para el usuario de integración y restableces la contraseña, se enviará de forma automática un correo electrónico con un token de seguridad nuevo. Puedes usar el token nuevo y pasar a Crea una app conectada.

De lo contrario, sigue estos pasos a fin de restablecer el token de seguridad para el usuario de integración:

  1. Accede a Salesforce como el usuario de integración mediante el nombre de usuario y la contraseña configurados en un paso anterior.
  2. En el menú principal, haz clic en la foto de perfil y, luego, en Settings.
  3. En el menú Settings, selecciona Reset My Security Token para abrir el panel Reset Security Token.
  4. Haz clic en el botón Reset Security Token.
  5. Busca un correo electrónico que contenga el token de seguridad nuevo en la cuenta de correo electrónico asociada con el usuario de integración. Toma nota del token de seguridad nuevo, ya que lo necesitará para un paso posterior.
  6. (Opcional) Habilita el permiso Solo usuario de API en System Permissions para tu conjunto de permisos, como se describió con anterioridad en Configura un conjunto de permisos.

Crea una app conectada

Se requiere el permiso de administración del sistema para configurar una app conectada. Si actualmente has iniciado sesión como usuarios de integración, asegúrate de salir y volver a acceder como sysadmin.

Sigue estos pasos para configurar una app conectada:

  1. Haz clic en el ícono de ajustes y selecciona Setup.
  2. En el menú Setup, busca y selecciona App Manager, como se muestra en la siguiente imagen: imagen que muestra la página Setup
  3. Haz clic en Nueva app conectada.
  4. En el panel de configuración, proporciona los siguientes detalles:
    • Connected App Name: ingresa un nombre para la aplicación conectada.
    • API Name: ingresa el nombre de la API.
    • Contact email: ingresa un correo electrónico para la app conectada. Lo ideal sería un alias de correo electrónico de grupo.
    • API (Enable OAuth Settings): selecciona Enable OAuth Settings. Luego, configura lo siguiente:
      1. (Opcional) Callback URL: esto solo es necesario si quieres que un servicio externo realice la validación. Si decides proporcionar una devolución de llamada, asegúrate de incluir el prefijo http(s)://.
      2. Selected OAuth Scopes: selecciona:
        • Acceder y administrar datos (API)
        • Realizar solicitudes en tu nombre en cualquier momento (refresh_token, offline_access)
  5. Haz clic en Guardar.
  6. Haga clic en Continuar.
  7. En la página siguiente, se muestran un secreto de consumidor y una clave de consumidor. Ten en cuenta estos valores, ya que se usarán cuando se configure el módulo de Auth para Apigee.
  8. Haz clic en el botón Administrar.
  9. En la página Connected App Detail, haz clic en el botón Edit Policies.
  10. En la sección OAuth Policies, cambia el valor del menú desplegable Permitted Users a Admin approved users are pre-authorized.
  11. Haz clic en Guardar.
  12. Desplázate hasta la sección Profiles y Permission Sets de la página para seleccionar el perfil o el conjunto de permisos que deseas aplicar a la app conectada.
  13. Selecciona el perfil o el conjunto de permisos deseados.
  14. Haz clic en Guardar.

Autenticación

Para usar esta tarea, debes configurar un perfil de autenticación con las Credenciales de cliente de OAuth 2.0. Las integraciones de Apigee usan el perfil de autenticación para conectarse a la instancia de Salesforce. Para crear un perfil de autenticación, sigue estos pasos:

  1. En las propiedades editables de la tarea, haz clic en + Nuevo perfil de autenticación para abrir el cuadro de diálogo Perfil de autenticación.
  2. Establece las siguientes propiedades:
    • En Authentication type, selecciona OAuth 2.0 resource owner password credentials.
    • Extremo del token:
      • Para la zona de pruebas, ingresa https://test.salesforce.com/services/oauth2/token
      • Para la producción, ingresa https://login.salesforce.com/services/oauth2/token
    • ID de cliente: Ingresa el identificador único del cliente.

      El ID de cliente es la clave del consumidor de la app conectada. Puedes encontrar la clave de consumidor en la página Administrar apps conectadas de la app conectada o en la definición.

    • Secreto: Ingresa el secreto del cliente.

      El secreto del cliente es el secreto del consumidor de la aplicación conectada. Puedes encontrar el secreto del consumidor en la página Administra apps conectadas de la app conectada o en la definición.

    • Alcance: El alcance del token de acceso.

      Los permisos te permiten especificar permisos de acceso para los usuarios. Puedes especificar varios permisos separados por un espacio.

    • USERNAME: Nombre de usuario para la autenticación.
    • PASSWORD: Contraseña de usuario.
    • Tipos de solicitudes: Selecciona cualquiera de los siguientes valores:
      • Parámetros de consulta
      • Cuerpo de la solicitud

      El tipo de solicitud que selecciones debe ser compatible con la instancia de Salesforce.

    • Parámetros de token: Solicita los parámetros necesarios para obtener el token.
    • Nombre del perfil de autenticación: Corresponde al nombre del perfil de autenticación.
    • Descripción del perfil de autenticación: Corresponde a la descripción del perfil de autenticación.
    • Certificado SSL: Sube el certificado SSL/TLS y la clave privada correspondiente.

      Si la clave privada tiene una frase de contraseña, ingrésala.

  3. Haz clic en Guardar.

Configura la tarea de lectura de registro de Salesforce

Para configurar la tarea Leer registro de Salesforce, haz lo siguiente:

  1. Ve a la IU de Apigee y accede.
  2. Selecciona tu organización mediante el menú desplegable que se encuentra en la esquina superior izquierda de la IU.
  3. Haz clic en Desarrollar > Integraciones.
  4. Busca o selecciona la integración que deseas editar en la lista Integraciones y haz clic para abrir el editor de integración.
  5. Haz clic en +Add a task/trigger > Tasks para ver la lista de las tareas disponibles.
  6. Arrastra el elemento Leer el registro de Salesforce al diseñador de integración.
  7. Haz clic en el elemento Leer el registro de Salesforce, en el diseñador, para ver el panel de configuración de la tarea Leer el registro de Salesforce.
  8. Elige el perfil de autenticación que creaste anteriormente en el menú desplegable Autenticación.
  9. Configura los campos restantes mediante las propiedades de configuración de la tarea.
  10. Los cambios en las propiedades se guardan de forma automática.

Propiedades de configuración

En la siguiente tabla, se describen las propiedades de configuración de la tarea Leer el registro de Salesforce.

Propiedad Tipo de datos Descripción
Dominio de Salesforce String Nombre de la instancia de Salesforce a la que deseas conectarte.

El dominio de Salesforce está disponible en la URL de la instancia de Salesforce. Por ejemplo, INSTANCE_NAME.my.salesforce.com

Versión de la API de Salesforce String Versión actual de la API en tu instancia de Salesforce.

La versión actual de la API está disponible en la instancia de Salesforce en Configuración > API > Generar socio WSDL.

Nombre de objeto String Nombre del objeto de Salesforce que deseas leer.
ID de registro String ID del registro que se actualizará.

El valor de ID se crea automáticamente cuando insertas un registro. El valor del ID identifica de forma única el registro y no cambia durante la vida útil del registro.

Registro String Valor de retorno de la tarea.

Si la operación de lectura es exitosa, esta variable contiene los detalles del objeto de Salesforce que se lee.

Volver a intentar en caso de error

Puedes configurar varias estrategias de reintento para controlar los errores en una tarea. Las estrategias de reintento te permiten especificar cómo volver a ejecutar la tarea en caso de error. Para obtener más información, consulta Estrategias de manejo de errores.

Consideraciones

Es posible que las limitaciones de cuotas en tu instancia de Salesforce afecten el uso de esta tarea. Comunícate con tu administrador de Salesforce para asegurarte de que tu diseño de integración sea compatible con su cuota de Salesforce.