Skip to main content

​
Bienvenido a la API de La Pyme

La API REST de La Pyme te permite integrar nuestro sistema de gestión con tus aplicaciones. Podés acceder a datos de clientes, productos y realizar operaciones de manera segura usando API keys. Hoy la API pública convive en dos superficies:
  • v1: endpoints legacy para listados y operaciones CRUD clásicas.
  • v2: endpoints machine-first para flujos transaccionales con preview/commit, idempotencia y errores estructurados.
Si estás integrando agentes, automatizaciones o una app externa nueva, empezá por API v2 Machine-First.

​
Base URL

Todos los endpoints de la API están disponibles en: 
https://api.lapyme.com.ar

​
Autenticación

Todas las requests (excepto /health) requieren autenticación usando Bearer tokens. Incluí tu API key en el header Authorization: 
Authorization: Bearer tu_api_key
Necesitás obtener tu API key desde el Dashboard de La Pyme en la sección de Integraciones.

​
Formato de Response

No todos los endpoints comparten exactamente el mismo envelope. La versión importa:
  • v1 usa el formato legacy de success, data y pagination.
  • v2 usa requestId, envelopes estructurados de error, y en endpoints transaccionales puede responder con mode: "preview" o mode: "commit".

​
Response Exitoso de v1

{
  "success": true,
  "data": [
    // Datos del endpoint
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 150,
    "totalPages": 3
  }
}

​
Response de lectura en v2

{
  "requestId": "req_123",
  "success": true,
  "data": [],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 0,
    "totalPages": 1
  }
}

​
Response de error en v2

{
  "requestId": "req_123",
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Descripción del error",
    "retryable": false,
    "details": []
  }
}

​
Paginación

Los endpoints que devuelven listas soportan paginación usando los siguientes parámetros de query:
  • page: Número de página (empezando desde 1, default: 1)
  • limit: Cantidad de items por página (máximo 100, default: 50)

​
Rate Limiting

La API implementa rate limiting para asegurar un servicio estable:
  • Límite: 1000 requests por hora por API key
  • Headers: Las responses incluyen headers X-RateLimit-* con información sobre tu límite actual

​
Códigos de Error Comunes

CódigoDescripción
MISSING_API_KEYAPI key faltante en el request
INVALID_API_KEYAPI key inválido o expirado
INSUFFICIENT_SCOPETu API key no tiene permisos para esta operación
VALIDATION_ERRORParámetros de entrada inválidos
RESOURCE_NOT_FOUNDEl recurso solicitado no existe
INTERNAL_ERRORError interno del servidor
PRECONDITION_FAILEDUn commit v2 no puede ejecutarse hasta resolver bloqueos detectados
IDEMPOTENCY_CONFLICTLa misma Idempotency-Key fue reutilizada con otro payload

​
Próximos Pasos

  1. Configurá tu autenticación
  2. Si vas a integrar compras o agentes, leé API v2 Machine-First
  3. Explorá los endpoints disponibles en la sección Endpoints
  4. Probá las requests directamente desde esta documentación usando el API playground
Todos los endpoints incluyen ejemplos interactivos que podés ejecutar directamente desde esta documentación.