¿Qué API utilizo?

Cuándo utilizar la API de REST

La API de REST proporciona una interfaz para servicios Web basada en REST potente, cómoda y sencilla para interactuar con Salesforce. Entre sus ventajas se incluyen su facilidad de integración y desarrollo, y es una excelente opción de tecnología para utilizar con aplicaciones móviles y proyectos Web. Para determinados proyectos, puede utilizar la API de REST con otras API de REST de Salesforce. Para crear una interfaz de usuario para crear, leer, actualizar y eliminar registros, así como crear una interfaz de usuario para vistas de lista, acciones y listas de selección dependientes, utilice la API de la interfaz de usuario. Para crear la interfaz de usuario para B2B Commerce en Lightning, contenido gestionado de CMS, sitios de Experience Cloud o Chatter, utilice la API de REST do Connect. Si tiene muchos registros para procesar, considere utilizar la API masiva, que se basa en los principios de REST y está optimizada para grandes conjuntos de datos.

Consulte Guía del desarrollador de la API de REST.

Cuándo utilizar la API de SOAP

La API de SOAP proporciona una interfaz para servicios web basada en SOAP potente, cómoda y sencilla para interactuar con Salesforce. Puede utilizar la API de SOAP para crear, recuperar, actualizar o eliminar registros. También puede utilizar la API de SOAP para realizar búsquedas y mucho más. Utilice la API de SOAP en cualquier idioma que admita los servicios web.

Por ejemplo, puede utilizar la API de SOAP para integrar Salesforce con los sistemas ERP y financieros de su organización. También puede entregar información de ventas y de asistencia en tiempo real a portales de compañía, y aportar información de clientes a sistemas de negocio críticos.

Consulte Guía del desarrollador de la API de SOAP.

Cuándo utilizar la API de REST de Connect

La API REST de Connect proporciona acceso programático a B2B Commerce for Lightning, contenido gestionado de CMS, sitios de Experience Cloud, archivos, notificaciones, temas y mucho más. Utilice la API de REST de Connect para mostrar noticias en tiempo real, usuarios y grupos de Chatter, especialmente en aplicaciones móviles.

Consulte Guía del desarrollador de la API de REST de Connect.

Cuándo utilizar la API de REST de Apex

Utilice la API de REST de Apex cuando desee mostrar sus métodos y clases de Apex de modo que las aplicaciones externas puedan acceder a su código a través de la arquitectura REST. La API de REST de Apex admite tanto OAuth 2.0 como el Id. de sesión para la autorización.

Consulte Guía del desarrollador de Apex : Exponer clases de Apex como servicios web de REST.

Cuándo utilizar la API de SOAP de Apex

Utilice la API de SOAP de Apex cuando desee mostrar métodos de Apex como API de servicios web de SOAP de modo que las aplicaciones externas puedan acceder a su código a través de SOAP.

La API de SOAP de Apex admite tanto OAuth 2.0 como el Id. de sesión para la autorización.

Consulte Guía del desarrollador de Apex: Exposición de métodos de Apex como servicios web de SOAPy Guía del desarrollador de la API de SOAP : Llamadas relacionadas con Apex.

Cuándo utilizar la API de REST de Analytics

Puede acceder a activos de CRM Analytics como por ejemplo, conjuntos de datos, lentes y tableros, de forma programática empleando la API de REST de Analytics. Envíe consultas y acceda a conjuntos de datos que se han importado en la plataforma de análisis. Crear y recuperar lentes. Acceder a información de XMD. Recupere una lista de versiones de conjuntos de datos. Cree y recupere aplicaciones de CRM Analytics. Cree, actualice y recupere tableros. Recuperar una lista de dependencias para una aplicación. Determinar qué funciones están disponibles para el usuario. Trabaje con instantáneas. Manipular conjuntos de datos replicados.

Consulte Guía del desarrollador de la API de REST de Analytics.

Cuándo utilizar la API de la interfaz de usuario

Cree una interfaz de usuario de Salesforce para aplicaciones móviles nativas y aplicaciones web personalizadas utilizando la misma API que utiliza Salesforce para crear Lightning Experience y Salesforce para Android, Salesforce para iOS y la aplicación móvil Salesforce. Cree interfaces de usuario que permitan a los usuarios trabajar con registros, vistas de lista, acciones, favoritos y mucho más. No solo obtiene datos y metadatos en una sola respuesta, sino también los cambios en los metadatos de coincidencias de respuesta hechos en la organización por los administradores de Salesforce. No tiene que preocuparse sobre diseños, listas de selección, seguridad a nivel de campo o colaboración: lo único que tiene que hacer es crear una aplicación que encante a los usuarios.

Consulte Guía del desarrollador de la API de la interfaz de usuario.

Cuándo utilizar la API de GraphQL

Cree aplicaciones con capacidad de ampliación y con capacidad de respuesta altamente con capacidad de devolución solo de los datos que necesita un cliente, todo en una única solicitud. La API de GraphQL supera los retos presentados por las API de REST tradicionales a través de la selección de campos, la agregación de recursos y la introspección de esquemas. La selección de campo reduce el tamaño de la carga, enviando de vuelta solo los campos que se incluyen en la consulta. Las agregaciones reducen las trayectorias de ida y vuelta entre el cliente y el servidor, devolviendo un conjunto de recursos relacionados en una única respuesta. La introspección de esquemas permite a un usuario ver los tipos, los campos y los objetos a los que tiene acceso.

Consulte la Guía del desarrollador de la API de GraphQL.

Cuándo utilizar la API de herramientas

Utilice API de herramientas para integrar metadatos de Salesforce con otros sistemas. Los tipos de metadatos se exponen como sObjects, de modo que puede acceder a un componente de un tipo complejo. Este acceso a nivel de campo acelera las operaciones en tipos de metadatos complejos. También puede crear herramientas de desarrollo personalizadas para aplicaciones de Force.com. Por ejemplo, utilice la API de herramientas para gestionar e implementar copias funcionales de clases y desencadenadores de Apex y páginas y componentes de Visualforce. También puede establecer puntos de control o marcadores de volcados de pila, ejecutar Apex anónimo y acceder a información de registro y de cobertura de código de programación.

Tanto REST como SOAP son compatibles.

Consulte API de herramientas.

Cuándo utilizar la API masiva 2.0

Utilice la API masiva 2.0 para consultar, consultar todo, insertar, actualizar, alterar o eliminar un gran número de registros de forma asíncrona. API masiva 2.0 está diseñada según el marco de trabajo REST de Salesforce.

Cualquier operación de datos que incluya más de 2.000 registros es un buen candidato para que la API masiva 2.0 prepare, ejecute y gestione correctamente un flujo de trabajo asíncrono que utilice el marco de trabajo masiva. Es mejor si los trabajos con menos de 2.000 registros implican llamadas sincronizadas “masificadas” en REST (por ejemplo, Compuesto) o SOAP.

Cuando se trabaja con grandes volúmenes de datos, es la forma más sencilla de crear, leer, actualizar y eliminar registros (CRUD) a escala. Si su trabajo incluye solo un tipo de sObject o extrae hasta 1 TB de datos por día, la API masiva 2.0 es su API de Salesforce.

Consulte Guía del desarrollador de API masiva y API 2.0.

Cuándo utilizar la API de metadatos

Utilice la API de metadatos para recuperar, implementar, crear, actualizar o eliminar personalizaciones para su organización. El uso más común es migrar los cambios desde un sandbox u organización de pruebas a su entorno de producción. El objetivo de la API de metadatos es gestionar personalizaciones y crear herramientas que puedan gestionar el modelo de datos, pero no los datos en sí.

La forma más sencilla de acceder a la función en API de metadatos es utilizar Extensiones de Salesforce para Visual Studio Code o la CLI de Salesforce. Ambas herramientas se crean sobre la API de metadatos y utilizan las herramientas estándar para simplificar el trabajo con la API de metadatos.

• Extensiones de Salesforce para Visual Studio Code incluye herramientas para desarrollar sobre Salesforce Platform en el editor ligero y ampliable de VS Code. Estas herramientas proporcionan funciones para trabajar con las organizaciones de desarrollo (organizaciones borrador, sandboxes y organizaciones de DE), Apex, componentes Aura y Visualforce.
• La CLI de Salesforce es ideal si utiliza una secuencia de comandos o línea de comandos para trasladar metadatos entre el directorio local y una organización de Salesforce.

Consulte Guía del desarrollador de la API de metadatos.

Cuándo utilizar la API Pub/Sub

Puede utilizar la API Pub/Sub para integrar sistemas externos con eventos. Las transmisiones de eventos se basan en cargas personalizadas a través de eventos de plataforma o cambios en registros de Salesforce a través de la Captura de datos de cambio. En Salesforce, puede publicar y suscribirse a eventos con desencadenadores de Apex, Process Builder y Flow Builder.

La API Pub/Sub está construida para la integración de eventos bidireccionales a alta escala con Salesforce. Utilice la API Pub/Sub para publicar y suscribirse de forma eficiente a mensajes de eventos binarios en el formato Apache Avro. La API Pub/Sub se basa en gRPC y HTTP/2 y utiliza un modelo basado en extracciones de modo que puede controlar el flujo de suscripción. Con API Pub/Sub, puede utilizar uno de los 11 lenguajes de programación compatibles con gRPC.

Utilice el tipo de evento de transmisión que se adapte a sus necesidades.

• Evento Captura de datos: Reciba los cambios en los registros de Salesforce con todos los campos cambiados. El evento de cambio de captura de datos admite más objetos estándar que los eventos de envío de tema y proporciona más funciones, como campos de encabezado que contienen información sobre el cambio.
• Evento de plataforma: Publique y reciba cargas personalizadas con un esquema predefinido. Los datos pueden ser cualquier cosa que defina, incluidos los datos de negocio, como la información de pedido. Especifique los datos que enviar mediante la definición de un evento de plataforma. Suscríbase a un canal de eventos de plataforma para recibir notificaciones.
• Eventos heredados: PushTopic y Evento genérico: PushTopic y eventos genéricos son eventos de primera generación. Tienen compatibilidad limitada y ya no se actualizan con nuevas funciones. Recomendamos que utilice eventos de Captura de datos de cambio en vez de eventos de envío de tema y eventos de plataforma en vez de eventos genéricos.

Consulte la documentación de la API Pub/Sub.