Saltar al contenido

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étodoRutaScopePara qué sirve
GET/v1/codescodes:readLista los códigos, con filtro por carpeta, tipo o estado
POST/v1/codescodes:writeCrea un códigoidempotente
GET/v1/codes/{id}codes:readObtiene un código con su diseño y sus reglas
PATCH/v1/codes/{id}codes:writeCambia el destino, el nombre, el diseño y las reglas
DELETE/v1/codes/{id}codes:writeElimina un código (su enlace corto responde 410)
POST/v1/codes/movecodes:writeMueve códigos a una carpetaidempotente
POST/v1/codes/move-domaincodes:writeMueve códigos a otro dominioidempotente
POST/v1/codes/tagscodes:writeAñade o quita etiquetas en varios códigosidempotente
POST/v1/codes/{id}/duplicatecodes:writeDuplica un códigoidempotente
PATCH/v1/codes/bulkcodes:writePausa, reanuda, archiva, etiqueta, mueve o elimina varios códigos
GET/v1/utm-presetscodes:readLista los ajustes UTM guardados
GET/v1/codes/{id}/versionscodes:readHistorial de destinos de un código
GET/v1/codes/{id}/activitycodes:readRegistro de actividad de un código
GET/v1/codes/{id}/exportcodes:readDescarga en SVG, PNG, PDF o EPS
GET/v1/codes/{id}/hosted-statscodes:readContadores de un código alojado
GET/v1/codes/{id}/submissionssubmissions:readRespuestas a un código de formulario
GET/v1/codes/{id}/submissions/exportsubmissions:readRespuestas del formulario en CSV
GET/v1/gs1/productscodes:readLista los productos GS1 (los códigos gs1)
GET/v1/codes/{id}/gs1/qualifierscodes:readNiveles de lote, CPV y número de serie de un código GS1
GET/v1/codes/{id}/gs1/print-runscodes:readTiradas de impresión de un código GS1
GET/v1/codes/{id}/gs1/print-runs/{runId}codes:readConsulta una tirada de impresión y obtiene los enlaces a sus archivos

Tandas en lote

MétodoRutaScopePara qué sirve
POST/v1/codes/bulkcodes:writeCrea hasta 500 códigos en una sola tandaidempotente
GET/v1/bulk-importscodes:readLista las tandas en lote
GET/v1/bulk-imports/{id}codes:readConsulta el estado de una tanda
GET/v1/bulk-imports/{id}/rowscodes:readFilas de una tanda
GET/v1/bulk-imports/{id}/results.csvcodes:readResultados de una tanda en CSV
POST/v1/bulk-imports/{id}/cancelcodes:writeCancela una tanda en cola o en cursoidempotente
POST/v1/bulk-imports/{id}/retrycodes:writeReintenta las filas fallidas de una tandaidempotente

Estadísticas

MétodoRutaScopePara qué sirve
GET/v1/analytics/summaryanalytics:readTotales de escaneos de un periodo
GET/v1/analytics/timeseriesanalytics:readEscaneos a lo largo del tiempo
GET/v1/analytics/breakdownanalytics:readPrincipales países, dispositivos, …
GET/v1/analytics/scansanalytics:readRegistros por escaneo
GET/v1/analytics/sparklinesanalytics:readRecuentos diarios de los códigos
GET/v1/analytics/compareanalytics:readCompara hasta 4 códigos
GET/v1/analytics/exportanalytics:readEscaneos en CSV (periodos cortos)
POST/v1/analytics/exportsanalytics:readEscaneos en CSV, preparados en segundo planoidempotente
GET/v1/codes/{id}/analytics/summaryanalytics:readTotales de un código
GET/v1/codes/{id}/analytics/timeseriesanalytics:readUn código a lo largo del tiempo
GET/v1/codes/{id}/analytics/breakdownanalytics:readListas principales de un código
GET/v1/codes/{id}/scansanalytics:readRegistros por escaneo de un código
GET/v1/codes/{id}/gs1/batchesanalytics:readEscaneos por lote de un código GS1
GET/v1/codes/{id}/downloadsanalytics:readDescargas por archivo de un código de Documentos
GET/v1/analytics/locationsanalytics:readMapa GPS de los escaneos con consentimiento
GET/v1/codes/{id}/analytics/locationsanalytics:readEl mapa GPS de un código
GET/v1/alertsanalytics:readLista las reglas de alerta de escaneos

Exportaciones

MétodoRutaScopePara qué sirve
POST/v1/exportscodes:readExporta muchos códigos en un solo ZIPidempotente
GET/v1/exportscodes:readLista las exportaciones
GET/v1/exports/{id}codes:readConsulta una exportación y obtiene el enlace del ZIP

Carpetas

MétodoRutaScopePara qué sirve
GET/v1/foldersfolders:readLista las carpetas
POST/v1/foldersfolders:writeCrea una carpetaidempotente
GET/v1/folders/{id}folders:readObtiene una carpeta
PATCH/v1/folders/{id}folders:writeCambia el nombre de una carpeta o la mueve
DELETE/v1/folders/{id}folders:writeElimina una carpeta (los códigos suben de nivel)

Plantillas

MétodoRutaScopePara qué sirve
GET/v1/templatestemplates:readLista las plantillas de diseño
POST/v1/templatestemplates:writeCrea una plantillaidempotente
GET/v1/templates/{id}templates:readObtiene una plantilla
PATCH/v1/templates/{id}templates:writeCambia una plantilla
DELETE/v1/templates/{id}templates:writeElimina una plantilla

Subidas

MétodoRutaScopePara qué sirve
POST/v1/assetscodes:writeSube un logotipo o un archivo
GET/v1/assets/{id}codes:readObtiene una subida con una URL firmada

Dominios

MétodoRutaScopePara qué sirve
GET/v1/domainsdomains:readLista los dominios personalizados
GET/v1/domains/{id}domains:readObtiene un dominio y su estado
GET/v1/subdomaindomains:readEl subdominio del espacio de trabajo y sus enlaces
GET/v1/subdomain/availabilitydomains:readComprueba si un nombre de subdominio está libre

Espacio de trabajo

MétodoRutaScopePara qué sirve
GET/v1/workspaces/currentcualquier claveEl espacio de trabajo de la clave y su plan
GET/v1/usagecualquier claveLímites del plan y uso de este mes

Webhooks

MétodoRutaScopePara qué sirve
GET/v1/webhookswebhooks:readLista los endpoints de webhook
POST/v1/webhookswebhooks:writeRegistra un endpoint y los tipos de eventoidempotente
GET/v1/webhooks/{id}webhooks:readObtiene un endpoint
PATCH/v1/webhooks/{id}webhooks:writeCambia o reactiva un endpoint
DELETE/v1/webhooks/{id}webhooks:writeElimina un endpoint
POST/v1/webhooks/{id}/testwebhooks:writeEnvía un evento webhook.testidempotente
GET/v1/webhooks/{id}/deliverieswebhooks:readEntregas de un endpoint
GET/v1/webhooks/{id}/deliveries/{deliveryId}webhooks:readUna entrega con sus intentos
POST/v1/webhooks/{id}/deliveries/{deliveryId}/redeliverwebhooks:writeReenvía una entregaidempotente
POST/v1/webhooks/{id}/recoverwebhooks:writeReenvía las entregas fallidasidempotente

Etiquetas

MétodoRutaScopePara qué sirve
GET/v1/tagstags:readLista las etiquetas
POST/v1/tagstags:writeCrea una etiquetaidempotente
GET/v1/tags/{id}tags:readObtiene una etiqueta
PATCH/v1/tags/{id}tags:writeCambia el nombre o el color de una etiqueta
DELETE/v1/tags/{id}tags:writeElimina una etiqueta (se quita de sus códigos)

Informes

MétodoRutaScopePara qué sirve
POST/v1/reportsanalytics:readGenera un informe de estadísticas en PDF o CSVidempotente
GET/v1/reportsanalytics:readLista los informes generados
GET/v1/reports/{id}analytics:readConsulta un informe y obtén su enlace

Hooks de Zapier y Make

MétodoRutaScopePara qué sirve
GET/v1/hookswebhooks:readLista los hooks de integración
POST/v1/hookswebhooks:writeSuscribe un hook a un eventoidempotente
DELETE/v1/hooks/{id}webhooks:writeCancela un hook
GET/v1/hooks/samples/{event}webhooks:readEventos recientes de un tipo, como muestra para un disparador

Tarjetas de visita

MétodoRutaScopePara qué sirve
GET/v1/cardscards:readLista las tarjetas de visita del equipo
POST/v1/cardscards:writeCrea una tarjeta de visitaidempotente
GET/v1/cards/{id}cards:readObtiene una tarjeta de visita
PATCH/v1/cards/{id}cards:writeCambia una tarjeta de visita
POST/v1/cards/{id}/deactivatecards:writeDesactiva una tarjeta de visitaidempotente
GET/v1/cards/{id}/analyticscards:readVistas, guardados y toques de una tarjeta

Conversiones

MétodoRutaScopePara qué sirve
POST/v1/conversionsconversions:writeRegistra una conversiónidempotente
GET/v1/analytics/funnelanalytics:readEmbudo del escaneo a los ingresos

Etiquetas NFC

MétodoRutaScopePara qué sirve
GET/v1/nfc/tagscodes:readLista las etiquetas NFC
POST/v1/nfc/tagscodes:writeRegistra una etiqueta NFC en un códigoidempotente