Skip to main content

Ambientes y base URL

Ambiente
string
required
Consulta los endpoints y esquemas en API Reference.

Autenticación

Todas las solicitudes deben incluir x-api-key.
curl -X GET "https://api.esolbay.com/api/v1/items/" \
  -H "x-api-key: $ESOLBAY_API_KEY"

Paginación y ordenado

Muchos listados soportan parámetros limit, offset, orderBy, order.
?limit=20&offset=0&orderBy=createdAt&order=desc

Versionado y estabilidad

  • Versionado vía prefijo de ruta (/api/v1).
  • Cambios incompatibles se publican en versiones mayores.

Errores

  • 400: solicitud inválida (valida tu payload)
  • 401: no autorizado (revisa x-api-key)
  • 404: recurso no encontrado
  • 500: error interno

Webhooks

Para recibir eventos (p. ej., order.create), configura un Webhook en el panel y valida firmas HMAC-SHA256. Revisa la guía de Webhooks y los esquemas en x-webhooks dentro de OpenAPI.

Mejores prácticas

  • Almacena x-api-key y secretos en un gestor seguro.
  • Implementa idempotencia con x-esolbay-event-id en Webhooks.
  • Limita y valida inputs en la integración.