Vai al contenuto

Riferimento API

Route

Le route non elencate qui sono solo per l’app e rispondono a una chiave con 403 session_required. Le route contrassegnate come idempotenti accettano un Idempotency-Key.

Codici

MetodoPercorsoScopeScopo
GET/v1/codescodes:readElenca i codici, con filtro per cartella, tipo o stato
POST/v1/codescodes:writeCrea un codiceidempotente
GET/v1/codes/{id}codes:readLeggi un codice con il suo design e le sue regole
PATCH/v1/codes/{id}codes:writeCambia destinazione, nome, design e regole
DELETE/v1/codes/{id}codes:writeElimina un codice (il suo link breve risponde 410)
POST/v1/codes/movecodes:writeSposta i codici in una cartellaidempotente
POST/v1/codes/move-domaincodes:writeSposta i codici su un altro dominioidempotente
POST/v1/codes/tagscodes:writeAggiungi o rimuovi tag su molti codiciidempotente
POST/v1/codes/{id}/duplicatecodes:writeDuplica un codiceidempotente
PATCH/v1/codes/bulkcodes:writeMetti in pausa, riattiva, archivia, assegna tag, sposta o elimina più codici
GET/v1/utm-presetscodes:readElenca i preset UTM salvati
GET/v1/codes/{id}/versionscodes:readCronologia delle destinazioni di un codice
GET/v1/codes/{id}/activitycodes:readFeed delle attività di un codice
GET/v1/codes/{id}/exportcodes:readScarica in SVG, PNG, JPG, PDF o EPS
GET/v1/codes/{id}/hosted-statscodes:readContatori di un codice ospitato
GET/v1/codes/{id}/submissionssubmissions:readRisposte a un codice modulo
GET/v1/codes/{id}/submissions/exportsubmissions:readRisposte del modulo in CSV
GET/v1/gs1/productscodes:readElenca i prodotti GS1 (i codici gs1)
GET/v1/codes/{id}/gs1/qualifierscodes:readLivelli di lotto, CPV e seriale di un codice GS1
GET/v1/codes/{id}/gs1/print-runscodes:readTirature di un codice GS1
GET/v1/codes/{id}/gs1/print-runs/{runId}codes:readControlla una tiratura e ottieni i link ai file

Esecuzioni in blocco

MetodoPercorsoScopeScopo
POST/v1/codes/bulkcodes:writeCrea fino a 500 codici in un’unica esecuzioneidempotente
GET/v1/bulk-importscodes:readElenca le esecuzioni in blocco
GET/v1/bulk-imports/{id}codes:readControlla un’esecuzione in blocco
GET/v1/bulk-imports/{id}/rowscodes:readRighe di un’esecuzione in blocco
GET/v1/bulk-imports/{id}/results.csvcodes:readRisultati di un’esecuzione in CSV
POST/v1/bulk-imports/{id}/cancelcodes:writeAnnulla un’esecuzione in coda o in corsoidempotente
POST/v1/bulk-imports/{id}/retrycodes:writeRiprova le righe non riuscite di un’esecuzioneidempotente

Statistiche

MetodoPercorsoScopeScopo
GET/v1/analytics/summaryanalytics:readTotali delle scansioni per un intervallo
GET/v1/analytics/timeseriesanalytics:readScansioni nel tempo
GET/v1/analytics/breakdownanalytics:readPaesi, dispositivi e altro più frequenti
GET/v1/analytics/scansanalytics:readRecord di ogni scansione
GET/v1/analytics/sparklinesanalytics:readConteggi giornalieri per i codici
GET/v1/analytics/compareanalytics:readConfronta fino a 4 codici
GET/v1/analytics/exportanalytics:readScansioni in CSV (intervalli brevi)
POST/v1/analytics/exportsanalytics:readScansioni in CSV, preparate in backgroundidempotente
GET/v1/codes/{id}/analytics/summaryanalytics:readTotali di un codice
GET/v1/codes/{id}/analytics/timeseriesanalytics:readUn codice nel tempo
GET/v1/codes/{id}/analytics/breakdownanalytics:readLe classifiche di un codice
GET/v1/codes/{id}/scansanalytics:readRecord di ogni scansione di un codice
GET/v1/codes/{id}/gs1/batchesanalytics:readScansioni per lotto di un codice GS1
GET/v1/codes/{id}/downloadsanalytics:readDownload per file di un codice Documenti
GET/v1/analytics/locationsanalytics:readMappa GPS delle scansioni con consenso
GET/v1/codes/{id}/analytics/locationsanalytics:readMappa GPS di un codice
GET/v1/alertsanalytics:readElenca le regole di avviso sulle scansioni

Esportazioni

MetodoPercorsoScopeScopo
POST/v1/exportscodes:readEsporta molti codici in un unico ZIPidempotente
GET/v1/exportscodes:readElenca le esportazioni
GET/v1/exports/{id}codes:readControlla un’esportazione e ottieni il link allo ZIP

Cartelle

MetodoPercorsoScopeScopo
GET/v1/foldersfolders:readElenca le cartelle
POST/v1/foldersfolders:writeCrea una cartellaidempotente
GET/v1/folders/{id}folders:readLeggi una cartella
PATCH/v1/folders/{id}folders:writeRinomina o sposta una cartella
DELETE/v1/folders/{id}folders:writeElimina una cartella (i codici salgono di livello)

Modelli

MetodoPercorsoScopeScopo
GET/v1/templatestemplates:readElenca i modelli di design
POST/v1/templatestemplates:writeCrea un modelloidempotente
GET/v1/templates/{id}templates:readLeggi un modello
PATCH/v1/templates/{id}templates:writeModifica un modello
DELETE/v1/templates/{id}templates:writeElimina un modello

Caricamenti

MetodoPercorsoScopeScopo
POST/v1/assetscodes:writeCarica un logo o un file
GET/v1/assets/{id}codes:readLeggi un caricamento con un URL firmato

Domini

MetodoPercorsoScopeScopo
GET/v1/domainsdomains:readElenca i domini personalizzati
GET/v1/domains/{id}domains:readLeggi un dominio e il suo stato
GET/v1/subdomaindomains:readIl sottodominio dello spazio di lavoro e i suoi link
GET/v1/subdomain/availabilitydomains:readVerifica se un nome di sottodominio è libero

Spazio di lavoro

MetodoPercorsoScopeScopo
GET/v1/workspaces/currentqualsiasi chiaveLo spazio di lavoro della chiave e il suo piano
GET/v1/usagequalsiasi chiaveLimiti del piano e utilizzo del mese

Webhook

MetodoPercorsoScopeScopo
GET/v1/webhookswebhooks:readElenca gli endpoint webhook
POST/v1/webhookswebhooks:writeRegistra un endpoint e i tipi di eventoidempotente
GET/v1/webhooks/{id}webhooks:readLeggi un endpoint
PATCH/v1/webhooks/{id}webhooks:writeModifica o riattiva un endpoint
DELETE/v1/webhooks/{id}webhooks:writeElimina un endpoint
POST/v1/webhooks/{id}/testwebhooks:writeInvia un evento webhook.testidempotente
GET/v1/webhooks/{id}/deliverieswebhooks:readConsegne di un endpoint
GET/v1/webhooks/{id}/deliveries/{deliveryId}webhooks:readUna consegna con i suoi tentativi
POST/v1/webhooks/{id}/deliveries/{deliveryId}/redeliverwebhooks:writeInvia di nuovo una consegnaidempotente
POST/v1/webhooks/{id}/recoverwebhooks:writeReinvia le consegne non riusciteidempotente

Tag

MetodoPercorsoScopeScopo
GET/v1/tagstags:readElenca i tag
POST/v1/tagstags:writeCrea un tagidempotente
GET/v1/tags/{id}tags:readLeggi un tag
PATCH/v1/tags/{id}tags:writeRinomina un tag o cambia colore
DELETE/v1/tags/{id}tags:writeElimina un tag (viene rimosso dai suoi codici)

Report

MetodoPercorsoScopeScopo
POST/v1/reportsanalytics:readGenera un report di statistiche in PDF o CSVidempotente
GET/v1/reportsanalytics:readElenca i report generati
GET/v1/reports/{id}analytics:readControlla un report e ottieni il link

Hook Zapier e Make

MetodoPercorsoScopeScopo
GET/v1/hookswebhooks:readElenca gli hook di integrazione
POST/v1/hookswebhooks:writeIscrivi un hook a un eventoidempotente
DELETE/v1/hooks/{id}webhooks:writeAnnulla l’iscrizione di un hook
GET/v1/hooks/samples/{event}webhooks:readEventi recenti di un tipo, come esempio per un trigger

Biglietti da visita

MetodoPercorsoScopeScopo
GET/v1/cardscards:readElenca i biglietti da visita del team
POST/v1/cardscards:writeCrea un biglietto da visitaidempotente
GET/v1/cards/{id}cards:readLeggi un biglietto da visita
PATCH/v1/cards/{id}cards:writeModifica un biglietto da visita
POST/v1/cards/{id}/deactivatecards:writeDisattiva un biglietto da visitaidempotente
GET/v1/cards/{id}/analyticscards:readVisualizzazioni, salvataggi e tocchi di un biglietto

Conversioni

MetodoPercorsoScopeScopo
POST/v1/conversionsconversions:writeRegistra una conversioneidempotente
GET/v1/analytics/funnelanalytics:readFunnel dalla scansione al ricavo

Tag NFC

MetodoPercorsoScopeScopo
GET/v1/nfc/tagscodes:readElenca i tag NFC
POST/v1/nfc/tagscodes:writeRegistra un tag NFC su un codiceidempotente