Skip to main content

​
Overview

La API de La Pyme usa API keys para autenticar requests. Cada API key está asociado a tu organización y tiene permisos específicos (scopes) que determinan qué operaciones podés realizar.

​
Obtener tu API Key

​
Paso 1: Acceder al Dashboard

  1. Iniciá sesión en Dashboard de La Pyme
  2. Navegá a Configuración > Integraciones
  3. En la sección “API Keys”, hacé click en Crear nuevo API Key

​
Paso 2: Configurar Permisos

Seleccioná los permisos que necesitás para tu integración:
ScopeDescripción
customers:readLeer información de clientes
customers:writeCrear, actualizar y eliminar clientes (incluye read)
products:readLeer información de productos
products:writeCrear, actualizar y eliminar productos (incluye read)
adminAcceso completo a todos los recursos
Los API keys con scope admin tienen acceso completo a tu organización. Usá este scope solo cuando sea necesario y mantené estas keys seguras.

​
Paso 3: Generar y Guardar

  1. Hacé click en Generar API Key
  2. Copiá y guardá el API key inmediatamente - no lo vas a poder ver de nuevo
  3. Dale un nombre descriptivo para identificarlo fácilmente

​
Usar tu API Key

Incluí tu API key en el header Authorization con el prefijo Bearer: 
curl -X GET "https://api.lapyme.com.ar/api/v1/customers" \
  -H "Authorization: Bearer tu_api_key_aqui" \
  -H "Content-Type: application/json"

​
Validar tu API Key

Podés verificar que tu API key funciona correctamente haciendo un request a cualquier endpoint. Si tu key es válido, vas a recibir una response exitosa. Si hay algún problema, vas a recibir uno de estos errores:

​
API Key Faltante

{
  "success": false,
  "error": "API key requerido",
  "code": "MISSING_API_KEY"
}

​
API Key Inválido

{
  "success": false,
  "error": "API key inválido",
  "code": "INVALID_API_KEY"
}

​
Permisos Insuficientes

{
  "success": false,
  "error": "Permisos insuficientes",
  "code": "INSUFFICIENT_SCOPE"
}

​
Mejores Prácticas de Seguridad

​
Monitoreo

Monitoreá el uso de tus API keys desde el Dashboard:
  • Última actividad: Cuándo se usó cada key por última vez
  • Requests por día: Cantidad de requests realizadas
  • Errores: Requests fallidas por key
Si detectás actividad sospechosa o pensás que tu API key fue comprometido, revocalo inmediatamente desde el Dashboard y creá una nueva.

​
Rate Limiting

Cada API key tiene límites de uso para asegurar un servicio estable:
  • Límite base: 1000 requests por hora
  • Burst: Hasta 100 requests por minuto
  • Headers: Las responses incluyen información sobre tu límite actual
Si necesitás un límite mayor, contactanos en [email protected].

​
Próximos Pasos

Una vez que tenés tu API key configurado:
  1. Probá hacer tu primer request al endpoint de health
  2. Explorá los endpoints de clientes
  3. Revisá la guía de inicio rápido para ejemplos completos