- Trabajos de consultoría para que la API de inaCátalog sea utilizada por terceros en un proceso de integración con inaCátalog.
- Configuración de accesos y permisos sobre la información requerida para realizar la integración.
- Asesoría y resolución de consultas sobre datos, envío y recepción.
La API de inaCátalog es configurable para que cada cliente, y cada perfil dentro del cliente, tenga acceso a sólo a lo que interesa, y sea lo más sencillo posible. Las tablas se organizan en un concepto lógico mayor, llamado entidades, para simplificar su comprensión y uso. Utiliza el código de respuestas HTTP para mantener informado al cliente de lo que está sucediendo. Nuestros endpoints devuelven la información en formato JSON.
Seguridad
Se utiliza el protocolo https, con lo que los datos viajan encriptados. Todas las solicitudes se validan con un token (JWT). Este token, le permitirá hacer todas las solicitudes, para las que tenga permiso, durante los siguientes 30 minutos a su obtención. Para obtener el token hay una autenticación inicial Basic Auth.
Permite distintos perfiles con distintos niveles de acceso configurables: las tablas o entidades a las que un perfil tiene acceso y lo que es capaz de hacer (obtener, insertar, actualizar, eliminar, eliminar todo) en cada tabla/entidad.
Documentación
La API es autodocumentada, informando de los endpoints disponibles:
> Cómo se llaman: parámetros y formato de los JSON a enviar, con los campos que son obligatorios.
> Las distintas respuestas posibles: códigos y mensajes o JSON asociados.
También se puede probar por sí sola. Además, se facilita una colección Postman para facilitar las pruebas desde esta aplicación. Esta colección replica cada una de las operaciones que existen en la documentación.
Otras Características
Tanto la obtención (GET), como la actualización (PUT) o inserción (POST) permite que sea de varios registros a la vez, permitiendo así una mayor velocidad de sincronización en su uso diario. Al actualizar datos sólo actualizará lo que se haya indicado; si se omite algún campo o registro, no se eliminará. Se permite el borrado de tablas enteras, si así interesa.
Depuración de errores: Las respuestas de error se acompañan del mensaje capturado, para que sea más fácil detectar el problema.
Permite la ejecución de procedimientos de la BBDD. Esto permite a nuestros implantadores facilitar a nuestro cliente tareas, como el borrado de datos antes de una actualización o ajustes de datos tras una actualización.
Incluye
- Configuración de los perfiles de usuario necesarios de accesos.
- Configuración de los permisos sobre las tablas y entidades requeridas.
- Documentación e información sobre los pasos necesarios para realizar la integración.
- Asesoría y resolución de consultas sobre datos, envío y recepción.
Información importante
La API se incluye de forma gratuita con su licencia de inaCátalog para tener acceso a todas las tablas y entidades del backoffice. Este servicio trata del apoyo y configuración necesario para limitar el acceso de terceros solo a las partes interesadas, según el grado de integración requerido.
Ref: 30033004
Última actualización: 1-3-2022