Saltar al contenido principal

Resumen de la API

La API de Snapbyte es una API REST que habla JSON sobre HTTPS. Está dirigida a los equipos que quieren conectar Snapbyte con sus propios sistemas: sincronizar menús, reaccionar a los pedidos o extraer datos hacia otra herramienta. Esta página cubre las convenciones que se aplican a todos los endpoints; cada endpoint concreto se documenta en su propia página.

URL base​

https://api.snapbyte.app/api/v1

El segmento v1 es la versión de la API. Snapbyte nunca romperá una versión publicada; el comportamiento nuevo se lanza bajo un nuevo prefijo de versión.

Autenticación​

Todas las solicitudes deben incluir un token de tipo bearer:

Authorization: Bearer sk_live_replace_me

Las claves están limitadas a un entorno (sandbox o production).

Estructura de la solicitud y la respuesta​

  • Todos los cuerpos de las solicitudes son JSON. Define Content-Type: application/json.
  • Todas las respuestas son JSON, incluso en caso de error.
  • Las marcas de tiempo son cadenas ISO 8601 en UTC.
  • Los identificadores llevan prefijo (por ejemplo, job_01h...) para que sean autodescriptivos en los registros.

Formato de error​

Los errores se devuelven con un estado distinto de 2xx y un cuerpo estructurado:

{
"error": {
"code": "invalid_request",
"message": "payload.message is required",
"param": "payload.message"
}
}

El campo code es estable y seguro para usar en condiciones; message está pensado para las personas y puede cambiar.

Límites de velocidad​

Snapbyte aplica límites de velocidad por clave. Cada respuesta incluye:

CabeceraSignificado
x-snapbyte-ratelimitSolicitudes permitidas en la ventana.
x-snapbyte-remainingSolicitudes restantes en la ventana.
x-snapbyte-resetMarca de tiempo Unix en la que se reinicia la ventana.

Ante un 429, espera hasta el momento indicado en reset. El SDK lo hace por ti.

Paginación​

Los endpoints de listado se paginan mediante cursor:

GET /v1/jobs?limit=50&cursor=eyJ...

La respuesta incluye un next_cursor (o null cuando has llegado al final). Los cursores son opacos: no intentes analizarlos.

A dónde ir después​