Extensión de Salesforce

Estás viendo la documentación de Apigee Edge.
Ve a la Documentación de Apigee X. información

Versión: 1.0.1

Accede a los datos de tu cuenta de Salesforce. Inserta, actualiza, recupera y consulta datos.

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

Requisitos previos

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

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

   Usarás la clave privada (.key) como credenciales cuando configures la extensión. Usarás el archivo de certificado (.crt) cuando crees una aplicación conectada que le dará 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 aplicación conectada de Salesforce proporcionará acceso a la extensión de Salesforce. Consulta las instrucciones que aparecen a continuación para configurar la app.

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

   1. En la configuración de Salesforce, en el panel de navegación izquierdo, ve a Apps > Administrador de aplicaciones.
   2. En la lista, busca la aplicación conectada que creaste.
   3. En el menú desplegable a la derecha de la fila de la aplicación, haz clic en Ver.
   4. En API (Habilitar configuración de OAuth), busca la Clave de consumidor y copia su valor en un lugar seguro para usarlo cuando configures la extensión.

Configura una app conectada para que acceda a ella mediante la extensión

Para que la extensión de Salesforce pueda acceder a Salesforce, deberás crear una aplicación 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 las 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 el panel de navegación de la izquierda, expande Apps > Administrador de aplicaciones.
4. En la página App Manager, haz clic en New Connected App.
5. En Basic Information (Información básica), completa los campos obligatorios. Los valores son para la contabilidad; pero la extensión no los usa.
6. En API (Enable OAuth Settings) (API [Habilitar configuración de OAuth]), selecciona la casilla de verificación Enable OAuth Settings (Habilitar configuración de OAuth).
7. Aunque la extensión no la usa, 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 Use digital signatures (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 Alcances seleccionados de OAuth, agrega lo siguiente para que se encuentren en Alcances seleccionados de OAuth:
    • 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 aplicaciones de la aplicación 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 Los usuarios aprobados por el administrador tienen autorización previa.
15. Haz clic en Guardar.
16. De regreso 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 del Administrador 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, localiza al usuario 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 y resolver problemas administrando mejor la información y las interacciones de los clientes, todo en una única plataforma a la que siempre se puede acceder desde cualquier computadora de escritorio o dispositivo.

Acciones

insert

Inserta registros como tipos 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

Un array results con resultados de la operación de inserción

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

update

Actualiza los 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

Un array 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 según sus ID. Muestra todos los campos del tipo 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

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

Realiza consultas en Salesforce.com con el lenguaje de consulta 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

Resultados de la consulta.

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

list

Haz una lista de los registros de Salesforce.com. Muestra 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

Un array records que contiene sObjects enumerados como JSON.

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

del

Borra registros con los ID 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

Un array 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

El token de acceso en 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 de extensión comunes

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.