Autenticación
- Roger Garcia
- Laura Ortiz
Antes de realizar cualquier petición a través de la API de Sagicc, es necesario autenticarse utilizando las credenciales de acceso de un usuario específico para obtener un token de acceso (access_token). Este proceso de autenticación se realiza mediante una solicitud de tipo POST al siguiente endpoint:
https://miinstancia.sagicc.co/oauth/token
El cuerpo (body) de la petición debe enviarse en formato multipart/form-data, y debe contener los siguientes parámetros (todos obligatorios):
username: Es la credencial de acceso del usuario que se empleará para acceder a la API. El username será el especificado en el módulo Credenciales de la API de Sagicc. Usualmente, será api@sagicc.co.
password: Es la contraseña de acceso del usuario que se empleará para acceder a la API. Puede consultase en el módulo Credenciales de la API de Sagicc.
client_id: Es un identificador para controlar el acceso a la API. Puede consultase en el módulo Credenciales de la API de Sagicc.
client_secret: Es una contraseña cifrada para controlar el acceso a la API. Puede consultase en el módulo Credenciales de la API de Sagicc.
En caso de que la petición POST sea exitosa, recibirás una respuesta con un código 200-OK. Esta respuesta incluirá un objeto en formato JSON, del cual podrás extraer el token de acceso (access_token) generado.
{
"token_type": "Bearer",
"expires_in": 31622400,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI4IiwianRpIjoiYWU2YmNlOWI0YWRjZGZkNTBjYTk0Yzk2ZDFhZTI0YmZmMTZmZjYxYzg2ZDg0ODM1YmRlZWUxMmI0Mzk1ZDAwZTFhMmY0NGFiZTczYWE0OWEiLCJpYXQiOjE2OTM1MDU2ODMuNDQzNzA0LCJuYmYiOjE2OTM1MDU2ODMuNDQzNzE0LCJleHAiOjE3MjUxMjgwODMuNDM1NzE1LCJzdWIiOiI5MyIsInNjb3BlcyI6W119.MvJP_tvAS9ejj3pAPj_Ubu41MNWI4Tw-klxqloQVIDl7cv0GrWo8pG_oJNllm5syetFz26ynH6gLYAIiZDcQxXC6BMqgRVIBCAMmGK2upqQ68QV43cHW7jzG8CLds82V9m6NEqO5i0CjiKm3TI3off3gyAmGTt7btWbPCzCAKQYqAyxp2ulGlCp3jqnk1e0KwxMaL5w8O4L80MIFkK0SFEMi1-_eMnCx5d40GohS8pSBMFW7XkSnJ7HLz6vG7Docydekya5AY1pmtR-BrYgVB82io-CnhNHI5Yxl4VZTisUHdneDaRRYRW3tMLD0KDZi1QsSvO-dAz19NrHqVKRU4hN2y9sqXyt3XRaknXp-sQOJhUhHtsCFTxRzIgSqS6L_7NHjwAaXa3a4aepHWir9CfJvyTKfTvRdqBG1QAhNWPZgMyidelMPD750lo35rgszT7GeYBFWd2RmfrFoGj9Dv3a7T2pLIIz8-5OnHgenxz8tNE9wig6NGHxp09BRW5qZAafbxXXyl1Qa8DvSUoqGHfo1h1GkCV7gBCGZiSrlNtGfTqzb5s5bASgz8VPn16otsfK8vCkl7vygxpZQFcXNgrtWgJLtG47zfdyjReE3F9bx1QVUDK9ikmUqa2pB8dFe-JmKeqEIRSM1SE5bD5tP515pzG31BZgygIep_3er5r4",
"refresh_token": "def5020007e770a098a1b269e47fd325ce9d184ad48343ba688624b77e09b6c98e2cd39ad82909527855fef806b783119f2ae4c2ca34b5f88869a8fe8c6121d6bff729171178a7ae22c79f93497f88b566d787cf283d65265cb7d86cd04fb242c1f4f913cf6001eb18ca82f6670a55dc70147c84b6c8518db9cf976bb8fa39450cc7a9a52b34842edb6ad6106692bd4ba743f7278b08d758ecfd748a856fd6417d74c4dc593fa0462ad9559c200b897ae3e59c519dde80b5eff6ec279526c8337d56e94a9ce3cbd8a7193e7f8c52376c554257a6b62d336c4f0f6042fdd946794b9c057fd9c332cd857fd3a619b4280f11f69c3c0f0ccb1d857fff910df0de4b21130543f23562024a61abe20845922d55026c9a4f48f930da1ee1cfd6d27b55daf952eae1fb93eaca31fd2654cc626d4a637da5cb8caf9ccee9bab4ad16f726bb61408b445e06c9851203b1ab6024cfef3704776cae1cb88f90e4e73a80d65gc98i"
}
Este token de acceso obtenido debe ser incluido en todas las otras peticiones a la API de Sagicc, específicamente en el encabezado de las peticiones, siguiendo la siguiente estructura:
Authorization: Bearer tu-token-de-acceso
Todos los tokens de acceso generados tendrán un tiempo de vida máximo de 365 días a partir de su fecha de creación. Una vez transcurrido este período, el token de acceso expirará y ya no podrá utilizarse para realizar peticiones. Te recomendamos tener esto en cuenta al consumir información de la API de Sagicc. Además, recuerda no compartir los tokens de acceso con personas no autorizadas para garantizar la seguridad de tus datos.
| Versión | Fecha | Comentarios |
|---|---|---|
| Versión actual (v. 6) | feb 21, 2025 21:46 | Laura Ortiz |
| v. 5 | ene 27, 2025 20:49 | Laura Ortiz |
| v. 4 | sept 02, 2024 18:45 | Laura Ortiz |
| v. 3 | ago 31, 2023 18:16 | Laura Ortiz |
| v. 2 | jun 02, 2022 00:18 | Roger Garcia |
| v. 1 | jun 01, 2022 23:39 | Roger Garcia |