Manual de Usuarios

Código: IDI-MA-01
Versión: 07
Vigencia desde: 06/05/2024

Ir al final de los metadatos
Ir al inicio de los metadatos

Estás viendo una versión antigua de esta página. Ve a la versión actual.

Comparar con el actual Ver el historial de la página

« Anterior Versión 6 Siguiente »

Una Interfaz de Programación de Aplicaciones, conocida también por la sigla API, en inglés, Application Programming Interface, es un conjunto de subrutinas, funciones y procedimientos que ofrece cierta biblioteca para ser utilizada por otro software como una capa de abstracción.

Todas las instancias Sagicc cuentan con una API que le permitirá a la empresa acceder y administrar la información de su instancia Sagicc a través de integraciones y desarrollos personalizados. La Sagicc API es una API con una estructura RESTful, que requiere de tokens de acceso para autorizar cada una de las peticiones, y que maneja el formato JSON tanto en el cuerpo de las peticiones como en las respuestas de las mismas.

Toda la documentación, métodos e información adicional sobre la API se encuentra en la URL https://nombre_empresa.sagicc.co/api/documentation (reemplaza la parte de nombre_empresa con el nombre asignado a tu instancia Sagicc).

A través del menú lateral y con un usuario con rol Administrador, puedes acceder al módulo de Credenciales de la API, en donde encontrarás las credenciales de acceso, documentación, y toda la información que necesitas para hacer uso de la Sagicc API de la instancia de tu empresa.

Una vez dentro del módulo, encontrarás la siguiente información necesaria para la autenticación a la Sagicc API y el uso de la misma:

  • Usuario: Corresponde al usuario de la Sagicc API de tu instancia Sagicc. Este usuario es de uso exclusivo para la API, y no podrá acceder a la plataforma como un usuario regular.

  • Contraseña: Es una contraseña de autenticación para el usuario de la Sagicc API. Es generada una sola vez, y sólo funcionará para consultar información de una instancia Sagicc.

  • URL de Autenticación: Es la URL que se utilizará para la autenticación a la API y la generación de los tokens de acceso necesarios para autorizar todas las peticiones a la API. Es una URL de la forma https://tuinstancia.sagicc.co/oauth/token.

Adicionalmente, en el módulo Credendiales de la API, encontrarás un listado con las llaves necesarias para la generación de los tokens de acceso de la API. En el listado, verás una o más llaves, que por seguridad se encontrarán ocultas. Haz clic en el botón Mostrar de cada llave para visualizarla. Copia y guarda estas llaves para su uso posterior al generar tokens de acceso para autorizar las peticiones a la Sagicc API.

Para garantizar la seguridad y confidencialidad de la información de tu empresa, NO compartas la información de este módulo con terceros o personas no autorizadas. Cualquier persona con acceso a las credenciales de la Sagicc API puede consultar o administrar la información de tu empresa.

Si por algúna razón sospechas que alguna credencial de este módulo se ha filtrado o detectas algún acceso no autorizado a la información, haz clic en el botón Refrescar en la parte superior derecha de la pantalla. De esta forma, se invalidará el parámetro Client Secret y se creará uno nuevo. Recuerda reemplazar este parámetro en todas sus integraciones con la Sagicc API para que sigan funcionando correctamente.

Versión Fecha Comentarios
Versión actual (v. 6) ene 02, 2023 19:51 Laura Ortiz
v. 10 sept 02, 2024 15:46 Laura Ortiz
v. 9 mar 04, 2024 17:12 Laura Ortiz
v. 8 ene 03, 2024 15:27 Laura Ortiz
v. 7 ago 31, 2023 16:18 Laura Ortiz
v. 6 ene 02, 2023 19:51 Laura Ortiz
v. 5 ene 02, 2023 19:42 Laura Ortiz
v. 4 ene 02, 2023 19:41 Laura Ortiz
v. 3 ago 06, 2022 15:04 Laura Ortiz
v. 2 jun 02, 2022 00:18 Roger Garcia
v. 1 jun 01, 2022 19:47 Roger Garcia
  • Sin etiquetas