Cómo gestionar las credenciales APi

APLICA PARA EL PLAN PROFESIONAL, AVANZADO Y SUPERIOR

Las APIs (Application Programming Interface) son interfaces que permiten la comunicación e integración entre la plataforma y sistemas externos, facilitando el intercambio automatizado de información entre diferentes aplicaciones o servicios.

A través de las APIs es posible consultar, registrar o actualizar información de manera controlada mediante los servicios disponibles en la documentación técnica, según las necesidades de integración de cada institución.

Este módulo no hace parte del estándar de la plataforma. Para utilizarlo, deberás solicitar al equipo de soporte la habilitación correspondiente, por medio de un ticket.

Una vez habilitado, podrás consultar la API Key desde la siguiente ruta:

Institucional → Establecimiento → Credenciales API

La API Key obtenida desde esta opción deberá utilizarse para autenticar las solicitudes realizadas a los diferentes endpoints disponibles en la documentación oficial:

Documentación APi

En este portal encontrarás la documentación técnica actualmente disponible para el consumo de las APIs. La documentación es estándar y está abierta para que el equipo técnico de la institución identifique y consuma los servicios que requiera (según aplique)

Importante:

Las credenciales API únicamente están disponibles para usuarios con rol Superadministrador (No existen permisos otorgables a otros administrativos).
La institución debe contar con un ingeniero o personal técnico especializado para realizar el consumo e integración de las APIs.
Desde nuestro alcance no brindamos acompañamiento en desarrollos, integraciones ni consumo de APIs.
El soporte ofrecido por nuestro equipo se enfoca en la validación de posibles novedades o inconsistencias que puedan presentarse en los servicios expuestos por la plataforma, siempre que estas estén relacionadas con el funcionamiento de la API y no con el desarrollo de la integración realizada por la institución.