AXUM API
Esta API permite la importación de los archivos necesarios para el funcionamiento de la web de los clientes, en formato CSV o JSON (también comprimidos en ZIP), y la consulta de pedidos, recibos, censos y más datos generados en AXUM.
- Pedí tu API Key a un administrador o a la mesa de ayuda de AXUM.
- Incluíla en el header
X-API-KEYde cada petición, con tu{tenant}en la ruta. - Ejecutá. Por ejemplo, para importar el catálogo de artículos:
curl --location 'https://gateway.axum.com.ar/{tenant}/api/v1/files/articulos' \ --header 'X-API-KEY: {tenant-apikey}' \ --form 'Articulos=@"articulos.csv"'
{
"success": true,
"message": "Archivo Articulos subido OK"
}Autenticación
Todas las peticiones requieren la API Key del tenant en la cabecera X-API-KEY. El {tenant} viaja en la ruta e identifica a la empresa.
| Header | Tipo | Descripción |
|---|---|---|
| X-API-KEY | StringRequired | Api key necesaria para la autenticación del endpoint. Un administrador o la mesa de ayuda le debe proporcionar la clave API Key. |
X-API-KEY: {tenant-apikey}Especificaciones generales — CSV
Todos los archivos de la importación CSV comparten el mismo formato. Un archivo por petición; para lotes grandes, comprimí en ZIP.
| Atributo | Valor |
|---|---|
| Formato de archivo | CSV / ZIP |
| Content-Type | multipart/form-data |
| Delimitador de líneas | CRLF (0D / 0A) |
| Cabecera | Sí |
| Delimitador de campos | , (coma) |
| Rellenar con espacios / ceros | No |
| Separador de decimales | . (punto) |
| Caracteres prohibidos dentro del campo | ' (comilla simple) " (comilla doble) , (coma) |
curl --location 'https://gateway.axum.com.ar/{tenant}/api/v1/files/{file-name}' \ --header 'X-API-KEY: {tenant-apikey}' \ --form '{file-name}=@"{file}"'
| Parámetro | Descripción |
|---|---|
| {tenant} | Nombre de la empresa. |
| {file-name} | Nombre del endpoint o archivo a subir sin extensión (ej: articulos, clientes, etc.). |
| {tenant-apikey} | API Key del tenant. |
| {file} | Contenido del archivo CSV o ZIP. |
Respuesta genérica
Todos los endpoints de importación devuelven el mismo esquema, indicando si la carga fue exitosa y el posible motivo del error.
| Campo | Tipo | Descripción |
|---|---|---|
| success | BooleanRequired | Indica si la importación de registros fue exitosa. |
| message | String | Mensaje indicando si la carga fue exitosa o no y el posible motivo. |
{
"success": true,
"message": "Archivo Articulos subido OK"
}{
"success": true,
"message": "Articulos: Sin cambios respecto a la última vez"
}{
"success": false,
"message": "Error subiendo archivo clientes.csv -> Ha ocurrido un error inesperado al intentar actualizar la tabla."
}Códigos de respuesta
La API utiliza los siguientes códigos de respuesta HTTP.
| Código | Significado |
|---|---|
| 200 OK | La solicitud se completó con éxito y la respuesta contiene los datos solicitados. |
| 403 Forbidden | La solicitud no incluye una API key válida en el header X-API-KEY. |
| 404 Not Found | La solicitud no incluye el header X-API-KEY o la URL es incorrecta. |
| 429 Too Many Requests | Se excede el límite de requests por minuto. |
| 500 Internal Server Error | Se produjo un error interno en el servidor. Intentalo de nuevo más tarde. |
Paginación
Los endpoints de consulta de gran volumen —Pedidos, Recibos y Respuestas— se recorren de a lotes con batchSize e idDesde, en lugar de traer todo en una sola petición.
- Pedí un primer lote indicando
batchSize(máximo 5000). - Procesá los registros y guardá el
idmás alto que recibiste. - Pedí el siguiente lote pasando ese id en
idDesde. - Repetí hasta que el lote vuelva vacío o con menos registros que
batchSize.
curl --location 'https://gateway.axum.com.ar/{tenant}/api/v1/pedidos?batchSize=5000&idDesde=11231234' \ --header 'X-API-KEY: {tenant-apikey}'
marcar-procesados para no volver a recibirlos.