Usar la API de REST

Objetivos de aprendizaje

Después de completar esta unidad, podrá:

• Iniciar sesión en la aplicación Postman y dirigirse a la carpeta REST en la recopilación de API de Salesforce.
• Utilizar el recurso Describir SObject mediante GET.
• Crear una cuenta con la API de REST.
• Ejecutar una consulta con la API de REST.

Nota

¿Es su idioma de aprendizaje español (LATAM)? Comience el reto en un Trailhead Playground en español (LATAM) y utilice las traducciones entre paréntesis para navegar. Copie y pegue solo los valores en inglés, ya que las validaciones del reto dependen de los datos en ese idioma. Si no aprueba el reto en su organización en español (LATAM), recomendamos que (1) cambie la configuración local a Estados Unidos, (2) cambie el idioma a inglés (según estas instrucciones) y, luego, (3) haga clic en el botón “Check Challenge” (Comprobar el reto) nuevamente.

Consulte la insignia Trailhead en su idioma para obtener más información sobre cómo aprovechar la experiencia de Trailhead en otros idiomas.

Métodos y recursos de REST

Va a utilizar Postman para realizar algunas llamadas de API. Puede realizar solicitudes REST desde cualquier remitente HTTP. Y Postman es una de las muchas herramientas que puede utilizar para interactuar con su organización de Salesforce a través de la API.  

El primer paso es crear un nuevo Trailhead Playground, conectarlo a la aplicación Postman, configurar el uso compartido de recursos de origen cruzado y crear una bifurcación de la recopilación de API de Salesforce. Puede hacer esto si completa Inicio rápido: Conectar Postman a Salesforce. 

Puede realizar llamadas de API de REST a su Trailhead Playground con los recursos en la aplicación Postman de la carpeta REST de la recopilación de Salesforce, como haría con cualquier otra interfaz HTTP. Cuando selecciona un recurso de la recopilación de API de Salesforce, el URI se crea en la parte superior de la ventana principal. 

Describir el objeto de cuenta

Echemos un vistazo a cómo funciona.

Utilizará el recurso Describir SObject. Este recurso, en combinación con el método GET, devuelve metadatos de un objeto y sus campos. Vamos a describir el objeto Cuenta. 

1. En Recopilaciones, seleccione la bifurcación de la Recopilación de API de Salesforce.
2. Haga clic en la carpeta REST.
3. Haga clic en SObject.
4. Haga clic en SObject Describe mediante GET.
5. En el panel principal, abra la ficha Parámetros.
6. En Variables de rutas, en la fila SOBJECT_API_NAME, columna VALUE, ingrese Cuenta.

Antes de echar un vistazo a los resultados de la consulta, dediquemos un minuto a desglosar el URI de este recurso.

• GET: método HTTP que se utiliza para esta llamada de API.
• {{_Endpoint}}: lugar donde se realizará la solicitud. En este caso, agregó la URL de su Trailhead Playground al campo _endpoint en las variables para conectarse a Salesforce.
• /services/data: especifica que realiza una solicitud de API de REST.
• /v {{version}}: número de versión de API. Las comillas dobles indican que esto se puede establecer como variable.
• /Sobjects: especifica que accederá a un recurso de la agrupación sObject.
• /:SOBJECT_API_Name: sObject procesado; en este caso, Cuenta.
• /describe: acción; en este caso, una solicitud de descripción.

¡Buen trabajo, capitán! Los metadatos de cuenta aparecen en la pantalla, y Postman proporcionó la respuesta en un formato bien presentado. Para ver la respuesta JSON sin procesar, haga clic en Sin procesar.

Los metadatos de cuenta se muestran en JSON. Dado que la API de REST es compatible con JSON y XML, vamos a cambiar el encabezado de la solicitud para especificar una respuesta XML. 

1. En la ventana de solicitud, haga clic en Encabezados.
2. Agregue un nuevo encabezado con el valor de Key (Clave) Accept (Aceptar) y el valor application/xml.

Los encabezados de solicitud deben ser similares a este.

{
"Name": "Captain Bly’s Finest Treasure Chests",
"ShippingCity": "Lisbon"
}

{
"ShippingCity" : "Melbourne"
}

SELECT Name From Account WHERE ShippingCity = 'Melbourne'

Ejemplos de Node.js y Ruby

const jsforce = require("jsforce");const conn = new jsforce.Connection({
  // you can change loginUrl to connect to sandbox or prerelease env.
  // loginUrl : "https://test.salesforce.com"
});
// Log in with basic SOAP login (see documentation for other auth options)
conn.login(
  process.env.USERNAME,
  process.env.PASSWORD + process.env.SECURITY_TOKEN,
  (err, res) => {
    if (err) {
      return console.error("Failed to log in to Salesforce: ", err);
    }
    console.log("Successfully logged in!");
    // Run a SOQL query
    conn.query("SELECT Id, Name FROM Account LIMIT 5", (err, result) => {
      if (err) {
        return console.error("Failed to run SOQL query: ", err);
      }
      // Display query results
      const { records } = result;
      console.log(`Fetched ${records.length} records:`);
      records.forEach(record => {
        console.log(`- ${record.Name} (${record.Id})`);
      });
    });
  }
);

require 'restforce'
# create the connection with the Salesforce connected app
client = Restforce.new :username => ENV['USERNAME'],
  :password       => ENV['PASSWORD'],
  :security_token => ENV['SECURITY_TOKEN'],
  :client_id      => ENV['CLIENT_ID'],
  :client_secret  => ENV['CLIENT_SECRET']
# execute the query
accounts = client.query("select id, name from account limit 5")
# output the account names
accounts.each do |account|
  p account.Name
end

Recursos