¿Qué es la extensibilidad de SIMA Suite?

Introducción

El propósito de este documento es servir como guía para el uso de las APIs de SIMA Suite. Aquí se describen las APIs disponibles, su propósito y funcionalidad cubierta, y, el enlace a la documentación en vivo en Swagger.

Además, es importante prestar atención a las Condiciones y restricciones de uso.

APIs de SIMA Suite

Las APIs disponibles se describen en cada sección, por favor, utilice el árbol para navegar por ellas.

Especificaciones técnicas

Todas las APIs de SIMA Suite son Rest API que utilizan oAuth2 como mecanismo de seguridad y autenticación. Es obligatorio instalar HTTPS para securizar las comunicaciones.

Además, todas esas APIs están versionadas. El versionado de APIs es la práctica de gestionar de forma transparente los cambios en su API. Gestionar una API se reduce a definir y evolucionar contratos de datos y a lidiar con cambios disruptivos.

Condiciones y restricciones de uso

En este párrafo se describen algunas restricciones para el uso de la API de SIMA Suite.

  1. Para evitar usos inesperados y problemas de rendimiento, el usuario debe especificar el uso previsto describiendo:
    1. El software que se va a conectar.
    2. El número esperado de llamadas por día.
  2. Aunque las API están versionadas, con el tiempo las versiones más antiguas podrían ser desaprobadas, lo que significa que el software conectado debe adaptar sus interfaces a las versiones más recientes de la API.
  3. Aunque existen API con muchos métodos, no todos ellos están permitidos para ser utilizados desde herramientas externas; este tema debe definirse con AIDA durante las sesiones de propuesta de conexión.

¿Cómo obtener más información?

Si desea más información o también tener acceso a la documentación en vivo de las API, contáctenos aquí

Idioma: