Documentación de la API

Aprende a integrar la API de Mercozy para gestionar productos, pedidos, inventario y más.

Primeros Pasos

Obtén tu clave API

Inicia sesión como Admin y ve a Configuración > Integración > Claves API para generar una nueva clave. Solo los usuarios Admin tienen permiso.

Inclúyela en las solicitudes

Agrega el encabezado X-API-Key a todas tus solicitudes API.

Comienza a hacer solicitudes

Usa cualquier cliente HTTP para interactuar con los endpoints de la API de Mercozy.

Autenticación

Todas las solicitudes API requieren una clave API válida enviada mediante el encabezado X-API-Key.

bash

curl https://api.mercozy.com/api/v1/external/products \
  -H "X-API-Key: mk_live_your_key_here"

Las claves API están vinculadas a tu tenant. Mantenlas en secreto y nunca las expongas en código del lado del cliente.

URL Base

https://api.mercozy.com/api/v1/external

Límites de Tasa

Los límites de tasa de la API dependen de tu plan de suscripción.

Plan	Límite de Tasa	Acceso API
Free / Standard	Sin acceso API	No
Pro	300 sol/min	Yes
Business	1,000 sol/min	Yes

Formato de Respuesta

Todas las respuestas se devuelven en formato JSON.

Respuesta Exitosa

json

{
  "data": [
    {
      "id": "prod_abc123",
      "name": "Premium Widget",
      "price": 2999,
      "currency": "USD"
    }
  ],
  "meta": {
    "total": 42,
    "page": 1,
    "limit": 20
  }
}

Respuesta de Error

json

{
  "statusCode": 401,
  "message": "Invalid API key",
  "error": "Unauthorized"
}

Códigos de Error

Código	Estado	Descripción
VALIDATION_ERROR	400	Parámetros de solicitud inválidos
UNAUTHORIZED	401	Clave API inválida o ausente
FORBIDDEN	403	Permisos insuficientes
NOT_FOUND	404	Recurso no encontrado
CONFLICT	409	El recurso ya existe o hay un conflicto
RATE_LIMITED	429	Demasiadas solicitudes
INTERNAL_ERROR	500	Error interno del servidor