Documentación

Primeros pasos

Convenciones

  • Todas las rutas de abajo son relativas a la URL base. Las peticiones y respuestas son JSON; envía Content-Type: application/json en los POST.
  • Los ids son UUID. Las marcas de tiempo son ISO 8601 en UTC.
  • Los campos se identifican por su clave, un nombre en snake_case como client_name que el endpoint de plantilla devuelve junto a cada etiqueta. Se deriva de la etiqueta al guardar la plantilla por primera vez y se mantiene aunque la etiqueta se reescriba; el autor puede cambiarla en la plantilla.
  • Las respuestas llevan Cache-Control: no-store y cabeceras CORS permisivas, así que un cliente en el navegador funciona, pero un navegador es el lugar equivocado para un token de API.
  • La API lleva la versión en la ruta. Pueden añadirse campos a las respuestas sin cambiar de versión; nada se elimina ni se renombra dentro de v1.