La interfaz de programación de aplicacionesEn 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.
| Info |
|---|
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 la instancia Sagicc donde fue generada.
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 también 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.
| Nota |
|---|
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.
| Info |
|---|
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 |
| Info |
|---|
Recuerda que para poder usar la API debes comunicarte con soporte de Sagicc para que te den las credenciales de uso. Ya que todas los llamados a la misma se encuentran protegidosinstancia Sagicc). |
| Cambiar historial |
|---|