Referencia de la API
Rutas
Las rutas que no aparecen aquí son solo para la app y responden a una clave con 403 session_required. Las rutas marcadas como idempotentes aceptan una Idempotency-Key.
Códigos
| Método | Ruta | Scope | Para qué sirve |
|---|---|---|---|
| GET | /v1/codes | codes:read | Lista los códigos, con filtro por carpeta, tipo o estado |
| POST | /v1/codes | codes:write | Crea un códigoidempotente |
| GET | /v1/codes/{id} | codes:read | Obtiene un código con su diseño y sus reglas |
| PATCH | /v1/codes/{id} | codes:write | Cambia el destino, el nombre, el diseño y las reglas |
| DELETE | /v1/codes/{id} | codes:write | Elimina un código (su enlace corto responde 410) |
| POST | /v1/codes/move | codes:write | Mueve códigos a una carpetaidempotente |
| POST | /v1/codes/move-domain | codes:write | Mueve códigos a otro dominioidempotente |
| POST | /v1/codes/tags | codes:write | Añade o quita etiquetas en varios códigosidempotente |
| POST | /v1/codes/{id}/duplicate | codes:write | Duplica un códigoidempotente |
| PATCH | /v1/codes/bulk | codes:write | Pausa, reanuda, archiva, etiqueta, mueve o elimina varios códigos |
| GET | /v1/utm-presets | codes:read | Lista los ajustes UTM guardados |
| GET | /v1/codes/{id}/versions | codes:read | Historial de destinos de un código |
| GET | /v1/codes/{id}/activity | codes:read | Registro de actividad de un código |
| GET | /v1/codes/{id}/export | codes:read | Descarga en SVG, PNG, PDF o EPS |
| GET | /v1/codes/{id}/hosted-stats | codes:read | Contadores de un código alojado |
| GET | /v1/codes/{id}/submissions | submissions:read | Respuestas a un código de formulario |
| GET | /v1/codes/{id}/submissions/export | submissions:read | Respuestas del formulario en CSV |
| GET | /v1/gs1/products | codes:read | Lista los productos GS1 (los códigos gs1) |
| GET | /v1/codes/{id}/gs1/qualifiers | codes:read | Niveles de lote, CPV y número de serie de un código GS1 |
| GET | /v1/codes/{id}/gs1/print-runs | codes:read | Tiradas de impresión de un código GS1 |
| GET | /v1/codes/{id}/gs1/print-runs/{runId} | codes:read | Consulta una tirada de impresión y obtiene los enlaces a sus archivos |
Tandas en lote
| Método | Ruta | Scope | Para qué sirve |
|---|---|---|---|
| POST | /v1/codes/bulk | codes:write | Crea hasta 500 códigos en una sola tandaidempotente |
| GET | /v1/bulk-imports | codes:read | Lista las tandas en lote |
| GET | /v1/bulk-imports/{id} | codes:read | Consulta el estado de una tanda |
| GET | /v1/bulk-imports/{id}/rows | codes:read | Filas de una tanda |
| GET | /v1/bulk-imports/{id}/results.csv | codes:read | Resultados de una tanda en CSV |
| POST | /v1/bulk-imports/{id}/cancel | codes:write | Cancela una tanda en cola o en cursoidempotente |
| POST | /v1/bulk-imports/{id}/retry | codes:write | Reintenta las filas fallidas de una tandaidempotente |
Estadísticas
| Método | Ruta | Scope | Para qué sirve |
|---|---|---|---|
| GET | /v1/analytics/summary | analytics:read | Totales de escaneos de un periodo |
| GET | /v1/analytics/timeseries | analytics:read | Escaneos a lo largo del tiempo |
| GET | /v1/analytics/breakdown | analytics:read | Principales países, dispositivos, … |
| GET | /v1/analytics/scans | analytics:read | Registros por escaneo |
| GET | /v1/analytics/sparklines | analytics:read | Recuentos diarios de los códigos |
| GET | /v1/analytics/compare | analytics:read | Compara hasta 4 códigos |
| GET | /v1/analytics/export | analytics:read | Escaneos en CSV (periodos cortos) |
| POST | /v1/analytics/exports | analytics:read | Escaneos en CSV, preparados en segundo planoidempotente |
| GET | /v1/codes/{id}/analytics/summary | analytics:read | Totales de un código |
| GET | /v1/codes/{id}/analytics/timeseries | analytics:read | Un código a lo largo del tiempo |
| GET | /v1/codes/{id}/analytics/breakdown | analytics:read | Listas principales de un código |
| GET | /v1/codes/{id}/scans | analytics:read | Registros por escaneo de un código |
| GET | /v1/codes/{id}/gs1/batches | analytics:read | Escaneos por lote de un código GS1 |
| GET | /v1/codes/{id}/downloads | analytics:read | Descargas por archivo de un código de Documentos |
| GET | /v1/analytics/locations | analytics:read | Mapa GPS de los escaneos con consentimiento |
| GET | /v1/codes/{id}/analytics/locations | analytics:read | El mapa GPS de un código |
| GET | /v1/alerts | analytics:read | Lista las reglas de alerta de escaneos |
Exportaciones
| Método | Ruta | Scope | Para qué sirve |
|---|---|---|---|
| POST | /v1/exports | codes:read | Exporta muchos códigos en un solo ZIPidempotente |
| GET | /v1/exports | codes:read | Lista las exportaciones |
| GET | /v1/exports/{id} | codes:read | Consulta una exportación y obtiene el enlace del ZIP |
Carpetas
| Método | Ruta | Scope | Para qué sirve |
|---|---|---|---|
| GET | /v1/folders | folders:read | Lista las carpetas |
| POST | /v1/folders | folders:write | Crea una carpetaidempotente |
| GET | /v1/folders/{id} | folders:read | Obtiene una carpeta |
| PATCH | /v1/folders/{id} | folders:write | Cambia el nombre de una carpeta o la mueve |
| DELETE | /v1/folders/{id} | folders:write | Elimina una carpeta (los códigos suben de nivel) |
Plantillas
| Método | Ruta | Scope | Para qué sirve |
|---|---|---|---|
| GET | /v1/templates | templates:read | Lista las plantillas de diseño |
| POST | /v1/templates | templates:write | Crea una plantillaidempotente |
| GET | /v1/templates/{id} | templates:read | Obtiene una plantilla |
| PATCH | /v1/templates/{id} | templates:write | Cambia una plantilla |
| DELETE | /v1/templates/{id} | templates:write | Elimina una plantilla |
Subidas
| Método | Ruta | Scope | Para qué sirve |
|---|---|---|---|
| POST | /v1/assets | codes:write | Sube un logotipo o un archivo |
| GET | /v1/assets/{id} | codes:read | Obtiene una subida con una URL firmada |
Dominios
| Método | Ruta | Scope | Para qué sirve |
|---|---|---|---|
| GET | /v1/domains | domains:read | Lista los dominios personalizados |
| GET | /v1/domains/{id} | domains:read | Obtiene un dominio y su estado |
| GET | /v1/subdomain | domains:read | El subdominio del espacio de trabajo y sus enlaces |
| GET | /v1/subdomain/availability | domains:read | Comprueba si un nombre de subdominio está libre |
Espacio de trabajo
| Método | Ruta | Scope | Para qué sirve |
|---|---|---|---|
| GET | /v1/workspaces/current | cualquier clave | El espacio de trabajo de la clave y su plan |
| GET | /v1/usage | cualquier clave | Límites del plan y uso de este mes |
Webhooks
| Método | Ruta | Scope | Para qué sirve |
|---|---|---|---|
| GET | /v1/webhooks | webhooks:read | Lista los endpoints de webhook |
| POST | /v1/webhooks | webhooks:write | Registra un endpoint y los tipos de eventoidempotente |
| GET | /v1/webhooks/{id} | webhooks:read | Obtiene un endpoint |
| PATCH | /v1/webhooks/{id} | webhooks:write | Cambia o reactiva un endpoint |
| DELETE | /v1/webhooks/{id} | webhooks:write | Elimina un endpoint |
| POST | /v1/webhooks/{id}/test | webhooks:write | Envía un evento webhook.testidempotente |
| GET | /v1/webhooks/{id}/deliveries | webhooks:read | Entregas de un endpoint |
| GET | /v1/webhooks/{id}/deliveries/{deliveryId} | webhooks:read | Una entrega con sus intentos |
| POST | /v1/webhooks/{id}/deliveries/{deliveryId}/redeliver | webhooks:write | Reenvía una entregaidempotente |
| POST | /v1/webhooks/{id}/recover | webhooks:write | Reenvía las entregas fallidasidempotente |
Informes
| Método | Ruta | Scope | Para qué sirve |
|---|---|---|---|
| POST | /v1/reports | analytics:read | Genera un informe de estadísticas en PDF o CSVidempotente |
| GET | /v1/reports | analytics:read | Lista los informes generados |
| GET | /v1/reports/{id} | analytics:read | Consulta un informe y obtén su enlace |
Hooks de Zapier y Make
| Método | Ruta | Scope | Para qué sirve |
|---|---|---|---|
| GET | /v1/hooks | webhooks:read | Lista los hooks de integración |
| POST | /v1/hooks | webhooks:write | Suscribe un hook a un eventoidempotente |
| DELETE | /v1/hooks/{id} | webhooks:write | Cancela un hook |
| GET | /v1/hooks/samples/{event} | webhooks:read | Eventos recientes de un tipo, como muestra para un disparador |
Tarjetas de visita
| Método | Ruta | Scope | Para qué sirve |
|---|---|---|---|
| GET | /v1/cards | cards:read | Lista las tarjetas de visita del equipo |
| POST | /v1/cards | cards:write | Crea una tarjeta de visitaidempotente |
| GET | /v1/cards/{id} | cards:read | Obtiene una tarjeta de visita |
| PATCH | /v1/cards/{id} | cards:write | Cambia una tarjeta de visita |
| POST | /v1/cards/{id}/deactivate | cards:write | Desactiva una tarjeta de visitaidempotente |
| GET | /v1/cards/{id}/analytics | cards:read | Vistas, guardados y toques de una tarjeta |
Conversiones
| Método | Ruta | Scope | Para qué sirve |
|---|---|---|---|
| POST | /v1/conversions | conversions:write | Registra una conversiónidempotente |
| GET | /v1/analytics/funnel | analytics:read | Embudo del escaneo a los ingresos |
Etiquetas NFC
| Método | Ruta | Scope | Para qué sirve |
|---|---|---|---|
| GET | /v1/nfc/tags | codes:read | Lista las etiquetas NFC |
| POST | /v1/nfc/tags | codes:write | Registra una etiqueta NFC en un códigoidempotente |