En nuestras aplicaciones comunes, suele haber una gran cantidad de tipos de API que sirven para diversos intercambios de datos, así como varias arquitecturas y protocolos de API comunes. A continuación, discutiré con usted desde una perspectiva de integración, ¿qué significa usar API de diferentes tipos, arquitecturas y protocolos cuando se prepara para integrar múltiples servicios entre sí? ¿Qué herramientas podemos usar y a qué debemos prestar atención? ?
Tipos de API y complejidad de la integración
Normalmente, tenemos cuatro tipos de API comunes: pública, privada, asociada y compuesta. en:
API pública
Las API públicas también se denominan a veces API abiertas o externas. Como sugiere el nombre, cualquiera puede usarlo de manera abierta sin restricciones o con relativamente pocas. Estas API suelen ser una forma para que terceros se comuniquen con aplicaciones web desarrolladas por la Empresa. Algunas API públicas comunes que sirven a la mayoría de las PYMES son: PandaDoc, BigCommerce, DocuSign, NetSuite, etc.
Cómo integrarse con API pública
La integración con la API pública es relativamente fácil. Diferentes empresas le proporcionarán los documentos API necesarios, que describen el uso y los métodos de llamada de varios puntos finales, la autenticación y autorización de sus API, etc. De hecho, la mayoría de las plataformas de integración empresarial se basan en el concepto de API públicas. Los llamados conectores integrados que proporcionan son esencialmente la capa de abstracción API de cada aplicación web. Sin embargo, la complejidad y el alcance de su funcionamiento dependen del diseño y la documentación de la API.
En general, existen dos estrategias principales relacionadas con la integración de API públicas: utilizar software de terceros como iPaaS o desarrollar el suyo propio. Cuando elijas lo último, prepárate con la estrategia correspondiente diseñada para el mapeo de datos. Si bien muchas aplicaciones utilizarán el mismo patrón para nombrar campos comunes en la parte frontal, esos campos pueden tener etiquetas claramente diferentes en la parte posterior. Las estrategias adecuadas deben garantizar la trazabilidad, la precisión y la implementación relativamente rápida del proyecto, así como evitar algunos errores fácilmente evitables.
Vale la pena mencionar que si está buscando algunas API de acceso público para su proyecto, GitHub tiene una lista bastante exhaustiva de API públicas . Incluye claves API completas y autorización OAuth necesarias para aplicaciones web como pronósticos meteorológicos.
API privada
A diferencia de las API públicas, las API privadas solo están disponibles para una única empresa. Los desarrolladores empresariales suelen utilizarlos para permitir cierto grado de intercambio de datos entre aplicaciones web, proporcionar acceso a bases de datos empresariales y otros servicios internos compartidos, comunicarse con otras API internas o crear aplicaciones internas para los empleados de la empresa.
De hecho, cada vez más empresas reconocen el valor de utilizar sus propias API. Como resultado, pueden ahorrar más tiempo y recursos, aumentar la agilidad y flexibilidad de las aplicaciones y ayudar a reducir los costos operativos generales.
Cómo integrarse con API privada
Dado que las API privadas generalmente residen en entornos altamente seguros, la integración con ellas requiere pasar por firewalls o servicios VPN muy estrictos para iniciar llamadas (por supuesto, primero debe poder permitir el acceso externo). Esto significa que si desea saber si nuestro middleware de integración es realmente útil, debe verificar si tiene algún tipo de mecanismo/capa de seguridad para acceder al sistema local y a la aplicación web.
También vale la pena señalar que algunos aspectos que son críticos para el éxito de una API pública pueden parecer irrelevantes en una API privada. Por ejemplo, los mecanismos de seguridad no son importantes en las API privadas porque se supone que están protegidos por las políticas de seguridad existentes de la empresa. Además, dado que los desarrolladores suelen utilizar nombres internos o técnicos en la documentación, el control de versiones no está necesariamente incluido en el diseño.
Ya sea que esté codificando manualmente, un middleware de integración, un nuevo miembro del equipo u otro departamento, existen desafíos al integrar API privadas. Por lo tanto, si está a cargo de diseñar una API privada, le recomiendo que se prepare para las mejores prácticas y comprobaciones de la API tal como diseña una API pública.
API de socio
Las API de socios entran en una categoría de API internas, pero normalmente se comparten entre socios comerciales y clientes B2B en lugar de usarse dentro de una organización. Un caso de uso común para este tipo de API es conectar dos aplicaciones de software empresarial internas en la integración de la cadena de suministro o la integración del punto de venta. En tales casos, las API suelen actuar como una alternativa a la integración clásica de EDI (Electronic Data Interchange).
Las API de socios suelen tener funciones de autorización, autenticación y seguridad más sólidas. Pueden permitir que partes externas accedan a ciertos datos confidenciales. Por ejemplo, datos de clientes de aplicaciones CRM o ERP de socios, o datos médicos de pacientes de instituciones médicas.
Cómo integrarse con la API de socios
Dado que la API del socio no está disponible públicamente, es posible que no encuentre una integración que permita una "conexión" instantánea. Si va a integrar dichas API de socios, deberá proporcionar una buena codificación manual o buscar ayuda con middleware de integración que admita el autoservicio y conectores personalizados.
A veces, es posible que necesite conectar las API de socios con aplicaciones web basadas en EDI y luego necesite convertir varios formatos de datos, como EDIFACT a JSON. Por supuesto, una buena plataforma de integración empresarial a menudo puede admitir dichas funciones. Además, también puede utilizar varios analizadores dedicados, por ejemplo: Analizador de secuencias Javascript .
API compuesta
Personalmente, creo que la API compuesta tiene los escenarios de uso más amplios. Por ejemplo, al crear un pedido en un carrito de compras, se deben realizar múltiples llamadas API a múltiples puntos finales, que incluyen: crear un nuevo cliente, crear un nuevo pedido, agregar nuevos productos al pedido, mostrar productos clasificados, etc. Una API compuesta a menudo puede hacer todo este trabajo en una sola llamada. Sin duda, esto acelera la capacidad y eficiencia de la multitarea. Por ejemplo, aquí está el archivo de propiedades de la API REST compuesta :
{
"compositeRequest" : [{
"method" : "POST",
"url" : "/services/data/v52.0/sobjects/Account",
"referenceId" : "refAccount",
"body" : { "Name" : "Sample Account" }
},{
"method" : "POST",
"url" : "/services/data/v52.0/sobjects/Contact",
"referenceId" : "refContact",
"body" : {
"LastName" : "Sample Contact",
"AccountId" : "@{refAccount.id}"
}
}]
}En el archivo anterior, su API puede tener hasta 25 de las llamadas subsolicitudes en una llamada única.
Otro caso de uso útil para las API compuestas es extraer información de múltiples servicios para completar una sola tarea en el patrón arquitectónico de microservicios. Sin embargo, las API compuestas no necesariamente requieren la creación de API completamente nuevas. En muchos casos, puede aumentar el diseño de una API existente agrupando varias llamadas o solicitudes en una secuencia.
Cómo integrarse con API compuesta
Las API compuestas no son muy diferentes de las API públicas habituales en lo que respecta a la integración. De hecho, si su solución de plataforma de integración ya tiene conectores genéricos para REST o SOAP, puede usarlos fácilmente para conectarse a API compuestas.
Integre con diferentes arquitecturas y protocolos API
A continuación, analicemos brevemente cómo definir tipos de datos y comandos aceptables cuando se utilizan API con diferentes arquitecturas y/o protocolos. Por supuesto, la mayoría de las veces probablemente utilizará API como REST y SOAP. Entre ellos, REST es un estilo arquitectónico y SOAP es un protocolo. Comparten varias similitudes y pueden comunicarse a través de HTTP y XML, por lo que la integración entre sí es muy sencilla.
Por supuesto, existen diferencias significativas entre los dos. Por ejemplo,
- Para exponer partes específicas de la lógica empresarial de una aplicación web en el servidor, SOAP utiliza interfaces de servicio, mientras que REST utiliza URI.
- La API REST admite múltiples formatos de datos, incluidos: texto sin formato, XML, JSON y CSV, mientras que SOAP solo admite XML.
- En general, se considera que REST es más liviano y requiere menos recursos que SOAP.
En lo que respecta a la integración de las dos, necesitamos algún tipo de "traducción" entre las dos API. Cuando elige integrar manualmente estas API, puede utilizar herramientas como Postman para automatizar dichas operaciones. Por ejemplo, puede llamar a la API SOAP de una aplicación web y analizar el XML devuelto en los datos que necesita. Luego puede convertir ese XML a un formato como JSON y enviar estos datos a la API REST de otra aplicación web. Se puede ver que cuando su empresa implementa una API integrada que puede manejar la conversión de datos entre aplicaciones y servicios web basados en REST y SOAP de forma predeterminada, facilitará su trabajo y la eficiencia de la aplicación mejorará enormemente.
Hacer buen uso de las herramientas
Los ingenieros de front-end exitosos son muy buenos en el uso de herramientas. En los últimos años, los conceptos de código bajo se han vuelto populares, como Mendix en el extranjero y JNPF en China. Este nuevo método de desarrollo tiene una interfaz gráfica de configuración de arrastrar y soltar y es Compatible con componentes personalizados. La expansión del código ha mejorado enormemente la eficiencia en la construcción de sitios web de gestión de fondo del lado B.
Dirección de código abierto: Centro de experiencia JNPF
La cantidad de código es pequeña y la estabilidad y facilidad de ajuste del sistema estarán garantizadas hasta cierto punto. Basado en el generador de código, puede desarrollar aplicaciones multiterminales para subprogramas Web, Android, IOS y WeChat en una sola parada. Una vez que el código se genera automáticamente, se puede descargar localmente para el desarrollo secundario, lo que mejora efectivamente la eficiencia general del desarrollo. Al mismo tiempo, admite la implementación en múltiples entornos de nube y la implementación local proporciona la máxima seguridad, lo que le permite crear rápidamente productos adecuados para sus propios escenarios de aplicaciones.