Las API de REST permiten la integración de las soluciones de Composer con otros sistemas mediante la API de REST HTTP (es decir, el protocolo HTTP de acceso a los datos, que normalmente se denomina API de REST). Solo se admiten las API de REST que son compatibles con el tipo de contenido JSON (es decir, API con el encabezado Content-Type en application/json y Accept en application/json); no se admite ningún otro tipo de contenido como xml, binary, x-www-form-urlencoded, etc.
El autor de Composer podrá crear una nueva conexión de datos de tipo API de REST y, como cualquier otra conexión de datos, esta puede crearse en el ámbito de la solución o en la biblioteca de conexiones en el ámbito de la aplicación o en el ámbito global. Además, la conexión de datos de la API de REST se puede utilizar con otras funciones, como el control de consulta, el control de búsqueda, el control de servicio web, la resolución de participantes, etc.
Autenticación
Las credenciales para una conexión de API se pueden añadir mientras se crea la conexión de datos de API, es decir, habilitando el conmutador etiquetado como Habilitar credenciales del sistema o navegando a Credenciales de origen de datos.
-
Habilitar credenciales del sistema: Habilite este botón de alternancia para utilizar las credenciales proporcionadas aquí para la autenticación. Además, si se añaden credenciales de nivel de usuario junto con credenciales del sistema, las credenciales del sistema tienen prioridad sobre las de nivel de usuario. Si está Habilitado, el usuario debe introducir las credenciales al crear la conexión de origen de datos en esta página (se mostrarán el nombre de usuario y la contraseña). Si está Deshabilitado, el usuario debe introducir las credenciales en la página Credenciales de origen de datos (el nombre de usuario y la contraseña estarán ocultos).
-
Credenciales de nivel de usuario: para añadirlas a nivel de usuario, navegue a la esquina superior derecha de Evolve, haga clic en el nombre del usuario y luego seleccione Credenciales de origen de datos. El usuario podrá añadir credenciales para la conexión de la API de Rest con el tipo de autenticación Básica, Básica de Sap Hana o Salesforce, y con el conmutador Habilitar credenciales del sistema deshabilitado.
Para acceder a cualquier API, se necesitará un prefijo de ruta, que es una combinación de la URL de Evolve y palabras clave específicas, por ejemplo, <URL de Evolve>/svr.
Credenciales del origen de datos
Agregar
Al seleccionar Añadir, el usuario debe poder obtener credenciales para la conexión de datos de la API de Rest con el tipo de autenticación Básica, Básica de Sap Hana o Salesforce, y con Habilitar credenciales del sistema desactivado.
Editar
Al seleccionar Editar conexión, el usuario debería poder editar las credenciales usando la opción Editar
Eliminar
Al seleccionar la conexión añadida, el usuario debería poder suprimir las credenciales usando la opción Suprimir.
API de Evolve en formato REST expuestas para utilizar
Las API que se indican a continuación están protegidas con la puerta de enlace de API y su mecanismo de autenticación compatible.
Para las tres opciones de seguridad en la puerta de enlace de API, hay que utilizar los siguientes prefijos de ruta para acceder a la API:
Secreto de cliente: «<URL de Evolve>/svr»
Token seguro: «<URL de Evolve>/svr»
Certificado: «<URL de Evolve>/svrc»
| Nombre de API | Método HTTP | Distribuir | Descripción |
|---|---|---|---|
| Datos de referencia | GET |
<Prefijo de ruta>/api/v1/ReferenceData?AppName=<NombreDeAplicación>&LibraryName=<NombreDeBiblioteca>&SolutionName=<NombreDeSoluciónDeReferencia> |
Esta API se usa para acceder a los datos de las soluciones de datos de referencia. Esta API también admite filtros de OData limitados. |
| Datos de la solución | GET | <Prefijo de ruta>/api/v1/SolutionDataSet?AppName=<NombreDeAplicación>&SolutionDataName=<NombreDeSolución> |
Esta API se usa para acceder a los datos de las soluciones. Esta API también admite filtros de OData limitados. |
| Supervisión (alertas del sistema) | GET | <Prefijo de ruta>/api/v1/Monitoring/SystemAlerts/?NotificationId=<Id. de notificación> | Esta API devuelve las alertas del sistema Evolve (si las hay) que se muestran en la sección «Alertas del sistema» del panel de administración. |
| Supervisión (desestimación de alertas del sistema) | POST | <Prefijo de ruta>/api/v1/Monitoring/SystemAlerts/Dismiss?NotificationId=<Id. de notificación> | Esta API se usa para descartar/eliminar la notificación de un determinado id. de notificación. |