Versiones comparadas

Clave

  • Se ha añadido esta línea.
  • Se ha eliminado esta línea.
  • El formato se ha cambiado.

...

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 disponible de adicional sobre la API se encuentra en la url 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.

Image RemovedImage Added

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.

Image RemovedImage Added

Adicionalmente, en el módulo Credendiales de la API, encontrarás un listado con las llaves adicionales necesarias para la autenticación a la Sagicc 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 realizar autorizar las peticiones a la Sagicc API.

...