Esta es una traducción que desde EGA Futura ofrecemos como cortesía a toda la Ohana y comunidad de programadores, consultores, administradores y arquitectos de Salesforce para toda Iberoamérica.
El enlace a la publicación original, lo encontrarás al final de este artículo.
…
Salesforce ofrece cientos de API REST y SOAP bien documentadas que pueden ayudarle con todas sus necesidades de integración. Aunque la documentación y la colección de APIs de Postman le ayudan a explorar estas APIs, deben estar documentadas en un formato comprensible para el sistema para que los sistemas externos las consuman rápidamente. En esta entrada del blog, hablaremos de una nueva función que le permitirá integrar rápidamente Salesforce a un sistema externo.
Especificaciones de la API
Una especificación describe lo que puede hacer una API, cómo consumirla, los parámetros, los métodos de autenticación que acepta y lo que se puede esperar como respuesta en forma de formato legible para humanos y máquinas. El estándar de la industria para la especificación de la API SOAP es WSDL, y la especificación de la API REST es OpenAPI u OAS (anteriormente conocido como Swagger). La última versión de OAS es la 3.0 (OAS3).
Estas especificaciones son fácilmente consumidas por sistemas externos, herramientas, clientes API o librerías codegen acelerando el tiempo de comercialización de una solución impulsada por API. Este es el principio en el que se basa el asistente de servicios externos de Salesforce, que le ayuda a integrarse con sistemas de terceros más rápidamente al permitirle importar sus especificaciones de API.
Salesforce puede generar especificaciones SOAP en forma de archivo WSDL adaptado a su organización. En cuanto a las especificaciones REST, disponemos de especificaciones OAS3 para APIs como Apis REST de Einstein Vision y Language, pero nada para la plataforma principal, por lo que hemos puesto a prueba la capacidad de generar una especificación OAS3 para las APIs REST de Salesforce.
Especificación OpenAPI 3.0 para recursos REST de sObjects (Piloto)
Empezamos este viaje en el invierno ’21 produciendo especificaciones «estándar» para la API REST de sObjects. En la primavera del 21 estamos mejorando esto dándole un punto final que le permite descargar una especificación que refleja los puntos finales únicos de su organización y las personalizaciones de los objetos.
La especificación generada describe los siguientes recursos sObject:
/sobjects/sobjects/{sObjectName}/sobjects/{sObjectName}/{Id}/sobjects/{sObjectName}/describe
A continuación se muestra un ejemplo de especificación. Contiene algo de información básica sobre la API, la URL base de la org, los mecanismos de Auth que soporta, y enumera diferentes rutas. Cada ruta es un punto final de la API REST de sObjects, y hay diferentes rutas para diferentes objetos en la organización. Dado que la especificación refleja las personalizaciones de tu org, puedes ver rutas dedicadas para tus objetos personalizados también. Por ejemplo, esta especificación tiene una ruta "/sobjects/Product__c" para el objeto personalizado Product__c.
{ "openapi": "3.0.1", "info": { "title": "Lightning Platform REST API", "description": "La API REST proporciona una potente, cómoda y sencilla API de servicios web para interactuar con Lightning Platform...", "versión": "51.0" }, "servidores": [ { "url": "https://mydomain.salesforce.com/services/data/v51.0" } ], "componentes": { "securitySchemes": { "openIDConnectDiscovery": { ... }, "bearerAuth": { ... }, "oAuth2": { ... } } }, "caminos": { "/objetos": { ... }, "/objetos/Cuenta": { ... }, "/objetos/Cuenta/{id}":{ ... }, "/objetos/Producto__c": { ... } ... }
}
Vea la demoIntegre con la API REST de Salesforce utilizando OpenAPI 3 de DreamTX para profundizar en cómo generar la especificación y consumirla en Postman. Vea la sesión Vea el futuro de las API en Salesforce del Developer Track en DreamTX para ver cómo la nueva especificación OAS3 puede simplificar el proceso de integración de Salesforce con una aplicación de código abierto Lightning Web Components que utiliza Node.js como backend.
Lo que sigue
Si desea participar en el piloto «OpenAPI 3.0 Spec for sObjects REST Resources», póngase en contacto con su ejecutivo de cuentas de Salesforce o abra un caso de asistencia. Sus comentarios son muy importantes para nosotros, para que podamos ofrecerle la mejor experiencia de desarrollo posible.
Además, antes de que salga Summer ’21, no olvide actualizar sus integraciones para utilizar versiones de API superiores a la 20.
Recursos
Sobre el autor
Aditya Naag Topalli es un 13x Certified Lead Developer Evangelist en Salesforce. Se centra en los componentes web Lightning, los servicios de la plataforma Einstein y las integraciones. Escribe contenido técnico y habla con frecuencia en seminarios web y conferencias en todo el mundo. Sígalo en Twitter @adityanaag y consulte sus contribuciones en GitHub.
…
Esta es una traducción realizada por EGA Futura, y este es el link a la publicación original: https://developer.salesforce.com/blogs/2021/01/learn-moar-with-spring-21-openapi-3-0-spec-for-rest-api.html