Extensión de Salesforce

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X. info

Versión: 2.0.2

Acceder a los datos de tu cuenta de Salesforce Insertar, actualizar, recuperar y consultar datos

En este contenido, se proporciona información de referencia para configurar y usar esta extensión.

Requisitos previos

En este contenido, se proporciona información de referencia para configurar y usar esta extensión. Antes de usar la extensión desde un proxy de API con la política ExtensionCallout, debes hacer lo siguiente:

1. Crea un par de clave privada o certificación de RSA x509.

   Usarás la clave privada (.key) como credencial cuando configures la extensión. Usarás el archivo de certificado (.crt) cuando crees una app conectada que le otorgue a la extensión acceso a Salesforce.

   openssl req -x509 -sha256 -nodes -days 36500 -newkey rsa:2048 -keyout salesforce.key -out salesforce.crt
   
   

2. Configura una app conectada.

   Una app conectada de Salesforce proporcionará acceso a la extensión de Salesforce. Consulta las instrucciones para configurar la app.

3. Obtén la clave de consumidor para la app conectada. La extensión la usará cuando se autentique con la app.

   1. En la configuración de Salesforce, en la navegación de la izquierda, ve a Apps > App Manager.
   2. En la lista, busca la app conectada que creaste.
   3. En el menú desplegable que se encuentra a la derecha en la fila de la aplicación, haz clic en Ver.
   4. En API (Enable OAuth Settings), busca la clave del consumidor y copia su valor en un lugar seguro para usarlo cuando configures la extensión.

Configura una app conectada para que la extensión pueda acceder a ella

Antes de que la extensión de Salesforce pueda acceder a Salesforce, deberás crear una app conectada de Salesforce a través de la cual la extensión pueda conectarse con Salesforce.

En Salesforce, una app conectada proporciona una forma para que las aplicaciones externas se conecten a Salesforce a través de APIs.

Cómo configurar una app conectada

1. Accede a Salesforce.
2. Haz clic en el ícono de ajustes en la esquina superior derecha y, luego, en Configuración.
3. En la navegación de la izquierda, expande Apps > Administrador de apps.
4. En la página Administrador de apps, haz clic en Nueva app conectada.
5. En Basic Information (Información básica), completa los campos obligatorios. Los valores son para la contabilidad y la extensión no los usa.
6. En API (Enable OAuth Settings), selecciona la casilla de verificación Enable OAuth Settings.
7. Aunque no la use la extensión, ingresa una URL de devolución de llamada. Puedes usar http://localhost/ o algún otro host de marcador de posición.
8. Selecciona la casilla de verificación Usar firmas digitales.
9. En Usar firmas digitales, haz clic en Elegir archivo para ubicar y subir el salesforce.crt que generaste antes.
10. En la sección Selected OAuth Scopes, agrega lo siguiente para que aparezca en Selected OAuth Scopes:
    • Acceder y administrar datos (API)
    • Realizar solicitudes en tu nombre en cualquier momento (refresh_token, offline_access)
11. Haz clic en Guardar. Si hay algún error, es posible que debas volver a generar y subir el archivo salesforce.crt.
12. En la página de la app resultante, haz clic en Manage (Administrar)
13. En la página Administrador de apps de la app que acabas de crear, haz clic en Editar políticas.
14. En Políticas de OAuth, haz clic en el menú desplegable Usuarios permitidos y, luego, en Usuarios aprobados por el administrador con autorización previa.
15. Haz clic en Guardar.
16. En la página de la app, en Perfiles, haz clic en Administrar perfiles.

17. En la página Application Profile Assignment, selecciona las casillas de verificación de los perfiles de usuario que pueden usar esta aplicación.

    Asegúrate de seleccionar un perfil que corresponda al usuario cuyo nombre de usuario usarás cuando configures la extensión. También asegúrate de que al menos los usuarios administradores del sistema tengan acceso a esta aplicación.

    Puedes ver el parámetro de configuración del perfil del usuario en Salesforce. En el área Configuración, expande Usuarios > Usuarios, busca el usuario al que representará la extensión y, luego, ubica su perfil en la columna Perfil.

18. Haz clic en Guardar.

Acerca de Salesforce

Salesforce es una plataforma de administración de relaciones con clientes (CRM). La administración de relaciones con clientes ayuda a las empresas a comprender las necesidades de los clientes y resolver problemas mediante una mejor administración de la información y las interacciones de sus clientes, todo en una única plataforma a la que siempre se puede acceder desde cualquier computadora o dispositivo.

Acciones

insert

Inserta registros como tipos de sObject.

<Action>insert</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "records":[ records-to-insert ],
  "allOrNone": true | false
}]]></Input>

<Action>insert</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "records":[
    { "Name": "MyAccountName" }
  ],
  "allOrNone": true
}]]></Input>

Parámetros de solicitud

Respuesta

Es un array results con los resultados de la operación de inserción.

{
  results: [
    { id: '0011U00000LQ76KQAT', success: true, errors: [] },
    { id: '0011U00000LQ76LQAT', success: true, errors: [] }
  ]
}

update

Actualizar registros de Salesforce

<Action>update</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "records": [ records-to-update ],
  "allOrNone": true | false
}]]></Input>

<Action>update</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "records":[
    {
      "id":"0011U00000LQ76KQAT",
      "Name": "MyNewAccountName"
    }
  ],
  "allOrNone": true
}]]></Input>

Parámetros de solicitud

Respuesta

Es un array de results que contiene los resultados de la actualización.

{
  results: [
    { id: '0011U00000LQ76KQAT', success: true, errors: [] },
    { id: '0011U00000LQ76LQAT', success: true, errors: [] }
  ]
}

recuperar

Recupera registros como sObjects por sus IDs. Devuelve todos los campos del tipo de sObject.

<Action>retrieve</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "ids":[ IDs-of-records-to-retrieve ]
}]]></Input>

<Action>retrieve</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "ids":["0011U00000LQ76KQAT"]
}]]></Input>

Parámetros de solicitud

Respuesta

Es un array records de sObjects representados como JSON. Ten en cuenta que todas las propiedades de los objetos se incluyen en el JSON, incluso si el valor de la propiedad es nulo.

{
  records: [
    { sobject-json },
    { sobject-json }
  ]
}

querySOQL

Consultar Salesforce.com con el lenguaje de consultas de objetos de Salesforce (SOQL)

<Action>querySOQL</Action>
<Input><![CDATA[{
  "soql": soql-query-statement
}]]></Input>

<Action>querySOQL</Action>
<Input><![CDATA[{
  "soql": "SELECT Id, Name FROM Account"
}]]></Input>

Parámetros de solicitud

Respuesta

Son los resultados de la búsqueda.

{
  totalSize: 2,
  records: [
    {
      attributes: { attributes-of-record },
      Id: '0011U00000LQ76KQAT',
      Name: 'AccountName1'
    },
    {
      attributes: { attributes-of-record },
      Id: '0011U00000LQ76LQAT',
      Name: 'AccountName2'
    }
  ],
  done: true
}

list

Enumera los registros de Salesforce.com. Devuelve todos los campos del tipo de sObject especificado.

<Action>list</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "limit": max-number-of-records,
  "offset": record-index-at-which-to-begin-response-set
}]]></Input>

<Action>list</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "limit": 1000,
  "offset": 0
}]]></Input>

Parámetros de solicitud

Respuesta

Es un array records que contiene los sObjects enumerados como JSON.

{
  records: [
    { sobject-json },
    { sobject-json }
  ]
}

del

Borra los registros con los IDs especificados.

<Action>del</Action>
<Input><![CDATA[{
  "sobject": records-sObject-type,
  "ids":[ IDs-of-records-to-retrieve ]
}]]></Input>

<Action>del</Action>
<Input><![CDATA[{
  "sobject": "Account",
  "ids":["0011U00000LQ76KQAT"]
}]]></Input>

Parámetros de solicitud

Respuesta

Es un array de results que contiene los resultados de la operación.

{
  results:[
    { id: '0011U00000LQ76KQAT', success: true, errors: [] },
    { id: '0011U00000LQ76LQAT', success: true, errors: [] }
  ]
}

getAccessToken

Obtén el token de acceso a la API de Salesforce.com. Se puede usar para consultar APIs de REST.

<Action>getAccessToken</Action>
<Input><![CDATA[{}]]></Input>

Parámetros de solicitud

Ninguno

Respuesta

Token de acceso en formato JSON.

{
  "accessToken":"00D1U0000014m3hqswvoM22I5GTw9EJrztlZ8eSSka88Q",
  "scope":"api",
  "instanceUrl": "https://na85.salesforce.com",
  "id": "https://login.salesforce.com/id/00D1U0004564mutUAA/0051U43214qecVQAQ",
  "tokenType": "Bearer"
}

Referencia de configuración

Usa la siguiente información cuando configures e implementes esta extensión para usarla en proxies de API.

Propiedades comunes de las extensiones

Las siguientes propiedades están presentes para cada extensión.

Propiedades de este paquete de extensión

Especifica valores para las siguientes propiedades de configuración específicas de esta extensión.