v1.28 ›
Versión 1.28 · Actualizada el 2026-05-27

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.

!
El contenido de todas las peticiones debe ser menor a 4 MB.
Rate limit: 30 requests por minutoRequests simultáneos: 4
URL BASE
https://gateway.axum.com.ar/{tenant}/api
Empezá en 3 pasos
  1. Pedí tu API Key a un administrador o a la mesa de ayuda de AXUM.
  2. Incluíla en el header X-API-KEY de cada petición, con tu {tenant} en la ruta.
  3. Ejecutá. Por ejemplo, para importar el catálogo de artículos:
cURL
curl --location 'https://gateway.axum.com.ar/{tenant}/api/v1/files/articulos' \
  --header 'X-API-KEY: {tenant-apikey}' \
  --form 'Articulos=@"articulos.csv"'
200 OK · application/json
{
  "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.

HeaderTipoDescripción
X-API-KEYStringRequiredApi key necesaria para la autenticación del endpoint. Un administrador o la mesa de ayuda le debe proporcionar la clave API Key.
CABECERA
X-API-KEY: {tenant-apikey}
!
Nunca expongas la API Key en clientes públicos. Las peticiones se hacen server-to-server contra el gateway.

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.

AtributoValor
Formato de archivoCSV / ZIP
Content-Typemultipart/form-data
Delimitador de líneasCRLF (0D / 0A)
CabeceraSí
Delimitador de campos, (coma)
Rellenar con espacios / cerosNo
Separador de decimales. (punto)
Caracteres prohibidos dentro del campo' (comilla simple) " (comilla doble) , (coma)
cURL
curl --location 'https://gateway.axum.com.ar/{tenant}/api/v1/files/{file-name}' \
  --header 'X-API-KEY: {tenant-apikey}' \
  --form '{file-name}=@"{file}"'
ParámetroDescripció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.

CampoTipoDescripción
successBooleanRequiredIndica si la importación de registros fue exitosa.
messageStringMensaje indicando si la carga fue exitosa o no y el posible motivo.
SUCCESS · application/json
{
  "success": true,
  "message": "Archivo Articulos subido OK"
}
SUCCESS · SIN CAMBIOS
{
  "success": true,
  "message": "Articulos: Sin cambios respecto a la última vez"
}
ERROR
{
  "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ódigoSignificado
200 OKLa solicitud se completó con éxito y la respuesta contiene los datos solicitados.
403 ForbiddenLa solicitud no incluye una API key válida en el header X-API-KEY.
404 Not FoundLa solicitud no incluye el header X-API-KEY o la URL es incorrecta.
429 Too Many RequestsSe excede el límite de requests por minuto.
500 Internal Server ErrorSe 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.

Cómo recorrer todos los registros
  1. Pedí un primer lote indicando batchSize (máximo 5000).
  2. Procesá los registros y guardá el id más alto que recibiste.
  3. Pedí el siguiente lote pasando ese id en idDesde.
  4. Repetí hasta que el lote vuelva vacío o con menos registros que batchSize.
cURL
curl --location 'https://gateway.axum.com.ar/{tenant}/api/v1/pedidos?batchSize=5000&idDesde=11231234' \
  --header 'X-API-KEY: {tenant-apikey}'
!
Para Pedidos y Recibos, después de procesar cada lote marcá esos ids con el endpoint marcar-procesados para no volver a recibirlos.