Autenticación y límites de uso

Autenticación

Toda solicitud a /api/v1/* se autentica con una clave de API, enviada como token Bearer en el encabezado Authorization:

Authorization: Bearer sy_...

Las claves empiezan con sy_ y se muestran completas una única vez, justo al crearlas. Después, solo verá los primeros y últimos cuatro caracteres. Las claves caducan a los 30, 90 (predeterminado) o 365 días; usar una clave caducada devuelve un 401.

Cree una clave en Configuración → Desarrollador → Claves de API. Cada clave incluye una plantilla de permisos y una configuración de acceso a clientes:

Solo lectura — Lectura sobre todos los recursos — sin escritura, sin publicación.

Acceso completo — Lectura y escritura en todas partes, incluida la publicación y la gestión del equipo. Resérvelo para sistemas que usted controle por completo.

Personalizado — Elija lectura, lectura y escritura, o ningún acceso para cada recurso. Verá la lista completa al crear la clave.

Todos los clientes — La clave puede acceder a todos los clientes de su agencia, incluidos los que añada más adelante.

Clientes específicos — La clave se limita a una lista fija de clientes que usted elige al crearla. Las solicitudes para cualquier otro cliente devuelven un 403.

Límites de uso

Los límites de uso se aplican por agencia, no por clave, y varían según su plan. Si no sabe cuál es el suyo, consulte a su equipo de cuenta.

Si supera su límite, recibirá una respuesta 429 con un encabezado Retry-After que indica cuántos segundos esperar antes de volver a intentarlo.

Toda respuesta de error incluye un campo error que describe lo ocurrido. Algunos tipos de error incluyen campos adicionales con más detalle:

{
  "error": "locationId is required"
}

Códigos de estado