01Documento completo
La documentación detallada describe la autenticación, el formato de las respuestas, la carga masiva y cada uno de los métodos de carga (demanda despacho, inventario on hand, tránsitos desde proveedores y entre sucursales, lead times internos, relación proveedor–SKU, maestros de producto, proveedor, cliente y sucursal, configuración SKU por sucursal, descuentos, jerarquía y conversión de unidades) y de consulta (resultados de abastecimiento e indicadores).
02Acceso
Cada cliente tiene su propio ambiente, con su propia dirección base:
https://api.<cliente>.supply-syncro.cl
GPI Software entrega a cada cliente el nombre de su ambiente y un usuario y contraseña exclusivos para la integración. Con ellos se obtiene un token, que se envía en el encabezado Authorization de cada llamada.
Importante: cada ingreso exitoso genera un token nuevo e invalida el anterior. Obtén el token una vez, guárdalo y reutilízalo en tus procesos. Si haces pruebas con el mismo usuario que usa tu integración en producción, esa integración necesitará volver a ingresar.
Si tu ambiente tiene habilitada la documentación interactiva (Swagger), la encontrarás en la dirección base de tu API.
03Prueba de conexión
Estos dos pasos confirman que tienes acceso. La consulta del paso 2 solo lee datos: no crea ni modifica nada.
Paso 1. Obtener el token
curl -X POST https://api.<cliente>.supply-syncro.cl/api/v1/api_login/ \
-H "Content-Type: application/json" \
-d '{"username": "<usuario>", "password": "<contraseña>"}'
Respuesta esperada (200):
{
"mensaje": "Credenciales válidas.",
"user_id": 12,
"username": "<usuario>",
"token": "9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b"
}
Paso 2. Hacer una consulta con el token
Pide la primera sucursal del maestro de sucursales. El encabezado lleva la palabra Token, un espacio y el token recibido:
curl "https://api.<cliente>.supply-syncro.cl/api/v1/maestro_sucursal/?page_size=1" \
-H "Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b"
Respuesta esperada (200), paginada:
{
"links": { "next": "...?page=2&page_size=1", "previous": null },
"count": 42,
"total_pages": 42,
"results": [
{
"id_sucursal": "1001",
"descripcion_sucursal": "Sucursal Centro",
"cd": 0,
...
}
]
}
Si recibes esta respuesta, la conexión funciona. Si tu maestro de sucursales aún no tiene datos, verás "count": 0 y "results": [], que también confirma el acceso.
04Si algo falla
| Respuesta | Qué significa |
|---|---|
401 "Credenciales inválidas." | Usuario o contraseña incorrectos en el paso 1. |
400 "Errores de validación." | Falta el usuario o la contraseña en el cuerpo de la solicitud. |
401 "Authentication credentials were not provided." | La consulta no lleva el encabezado Authorization. |
401 "Invalid token." | El token no es válido o fue reemplazado por un ingreso posterior. Repite el paso 1. |
Revisa también que el encabezado diga Token y no Bearer, y que la dirección base corresponda al nombre de ambiente de tu empresa.
05Soporte
¿Necesitas credenciales para la integración o tienes dudas? Escríbenos desde el formulario de contacto o al correo contacto@gpisoftware.cl.