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 9 Siguiente »

En todas las instancias de Sagicc, se encuentra disponible una API que brinda a la empresa la capacidad de acceder y gestionar la informaci贸n espec铆fica de su instancia de Sagicc mediante integraciones y desarrollos personalizados. La API de Sagicc adopta un enfoque basado en la arquitectura RESTful y opera mediante tokens de acceso, los cuales son necesarios para autorizar cada solicitud realizada. Adem谩s, esta API est谩 dise帽ada para manejar el formato JSON tanto en el cuerpo de las solicitudes como en las correspondientes respuestas.

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.

Dentro de 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 este m贸dulo, encontrar谩s las credenciales de acceso, as铆 como tambi茅n la documentaci贸n y toda la informaci贸n necesaria para aprovechar al m谩ximo la API de Sagicc correspondiente a 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 Credenciales 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 alguna 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.

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).

Versión Fecha Comentarios
Versión actual (v. 9) mar 04, 2024 17:12 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