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
| Metodo | Percorso | Scope | Scopo |
|---|---|---|---|
| GET | /v1/codes | codes:read | Elenca i codici, con filtro per cartella, tipo o stato |
| POST | /v1/codes | codes:write | Crea un codiceidempotente |
| GET | /v1/codes/{id} | codes:read | Leggi un codice con il suo design e le sue regole |
| PATCH | /v1/codes/{id} | codes:write | Cambia destinazione, nome, design e regole |
| DELETE | /v1/codes/{id} | codes:write | Elimina un codice (il suo link breve risponde 410) |
| POST | /v1/codes/move | codes:write | Sposta i codici in una cartellaidempotente |
| POST | /v1/codes/move-domain | codes:write | Sposta i codici su un altro dominioidempotente |
| POST | /v1/codes/tags | codes:write | Aggiungi o rimuovi tag su molti codiciidempotente |
| POST | /v1/codes/{id}/duplicate | codes:write | Duplica un codiceidempotente |
| PATCH | /v1/codes/bulk | codes:write | Metti in pausa, riattiva, archivia, assegna tag, sposta o elimina più codici |
| GET | /v1/utm-presets | codes:read | Elenca i preset UTM salvati |
| GET | /v1/codes/{id}/versions | codes:read | Cronologia delle destinazioni di un codice |
| GET | /v1/codes/{id}/activity | codes:read | Feed delle attività di un codice |
| GET | /v1/codes/{id}/export | codes:read | Scarica in SVG, PNG, JPG, PDF o EPS |
| GET | /v1/codes/{id}/hosted-stats | codes:read | Contatori di un codice ospitato |
| GET | /v1/codes/{id}/submissions | submissions:read | Risposte a un codice modulo |
| GET | /v1/codes/{id}/submissions/export | submissions:read | Risposte del modulo in CSV |
| GET | /v1/gs1/products | codes:read | Elenca i prodotti GS1 (i codici gs1) |
| GET | /v1/codes/{id}/gs1/qualifiers | codes:read | Livelli di lotto, CPV e seriale di un codice GS1 |
| GET | /v1/codes/{id}/gs1/print-runs | codes:read | Tirature di un codice GS1 |
| GET | /v1/codes/{id}/gs1/print-runs/{runId} | codes:read | Controlla una tiratura e ottieni i link ai file |
Esecuzioni in blocco
| Metodo | Percorso | Scope | Scopo |
|---|---|---|---|
| POST | /v1/codes/bulk | codes:write | Crea fino a 500 codici in un’unica esecuzioneidempotente |
| GET | /v1/bulk-imports | codes:read | Elenca le esecuzioni in blocco |
| GET | /v1/bulk-imports/{id} | codes:read | Controlla un’esecuzione in blocco |
| GET | /v1/bulk-imports/{id}/rows | codes:read | Righe di un’esecuzione in blocco |
| GET | /v1/bulk-imports/{id}/results.csv | codes:read | Risultati di un’esecuzione in CSV |
| POST | /v1/bulk-imports/{id}/cancel | codes:write | Annulla un’esecuzione in coda o in corsoidempotente |
| POST | /v1/bulk-imports/{id}/retry | codes:write | Riprova le righe non riuscite di un’esecuzioneidempotente |
Statistiche
| Metodo | Percorso | Scope | Scopo |
|---|---|---|---|
| GET | /v1/analytics/summary | analytics:read | Totali delle scansioni per un intervallo |
| GET | /v1/analytics/timeseries | analytics:read | Scansioni nel tempo |
| GET | /v1/analytics/breakdown | analytics:read | Paesi, dispositivi e altro più frequenti |
| GET | /v1/analytics/scans | analytics:read | Record di ogni scansione |
| GET | /v1/analytics/sparklines | analytics:read | Conteggi giornalieri per i codici |
| GET | /v1/analytics/compare | analytics:read | Confronta fino a 4 codici |
| GET | /v1/analytics/export | analytics:read | Scansioni in CSV (intervalli brevi) |
| POST | /v1/analytics/exports | analytics:read | Scansioni in CSV, preparate in backgroundidempotente |
| GET | /v1/codes/{id}/analytics/summary | analytics:read | Totali di un codice |
| GET | /v1/codes/{id}/analytics/timeseries | analytics:read | Un codice nel tempo |
| GET | /v1/codes/{id}/analytics/breakdown | analytics:read | Le classifiche di un codice |
| GET | /v1/codes/{id}/scans | analytics:read | Record di ogni scansione di un codice |
| GET | /v1/codes/{id}/gs1/batches | analytics:read | Scansioni per lotto di un codice GS1 |
| GET | /v1/codes/{id}/downloads | analytics:read | Download per file di un codice Documenti |
| GET | /v1/analytics/locations | analytics:read | Mappa GPS delle scansioni con consenso |
| GET | /v1/codes/{id}/analytics/locations | analytics:read | Mappa GPS di un codice |
| GET | /v1/alerts | analytics:read | Elenca le regole di avviso sulle scansioni |
Esportazioni
| Metodo | Percorso | Scope | Scopo |
|---|---|---|---|
| POST | /v1/exports | codes:read | Esporta molti codici in un unico ZIPidempotente |
| GET | /v1/exports | codes:read | Elenca le esportazioni |
| GET | /v1/exports/{id} | codes:read | Controlla un’esportazione e ottieni il link allo ZIP |
Cartelle
| Metodo | Percorso | Scope | Scopo |
|---|---|---|---|
| GET | /v1/folders | folders:read | Elenca le cartelle |
| POST | /v1/folders | folders:write | Crea una cartellaidempotente |
| GET | /v1/folders/{id} | folders:read | Leggi una cartella |
| PATCH | /v1/folders/{id} | folders:write | Rinomina o sposta una cartella |
| DELETE | /v1/folders/{id} | folders:write | Elimina una cartella (i codici salgono di livello) |
Modelli
| Metodo | Percorso | Scope | Scopo |
|---|---|---|---|
| GET | /v1/templates | templates:read | Elenca i modelli di design |
| POST | /v1/templates | templates:write | Crea un modelloidempotente |
| GET | /v1/templates/{id} | templates:read | Leggi un modello |
| PATCH | /v1/templates/{id} | templates:write | Modifica un modello |
| DELETE | /v1/templates/{id} | templates:write | Elimina un modello |
Caricamenti
| Metodo | Percorso | Scope | Scopo |
|---|---|---|---|
| POST | /v1/assets | codes:write | Carica un logo o un file |
| GET | /v1/assets/{id} | codes:read | Leggi un caricamento con un URL firmato |
Domini
| Metodo | Percorso | Scope | Scopo |
|---|---|---|---|
| GET | /v1/domains | domains:read | Elenca i domini personalizzati |
| GET | /v1/domains/{id} | domains:read | Leggi un dominio e il suo stato |
| GET | /v1/subdomain | domains:read | Il sottodominio dello spazio di lavoro e i suoi link |
| GET | /v1/subdomain/availability | domains:read | Verifica se un nome di sottodominio è libero |
Spazio di lavoro
| Metodo | Percorso | Scope | Scopo |
|---|---|---|---|
| GET | /v1/workspaces/current | qualsiasi chiave | Lo spazio di lavoro della chiave e il suo piano |
| GET | /v1/usage | qualsiasi chiave | Limiti del piano e utilizzo del mese |
Webhook
| Metodo | Percorso | Scope | Scopo |
|---|---|---|---|
| GET | /v1/webhooks | webhooks:read | Elenca gli endpoint webhook |
| POST | /v1/webhooks | webhooks:write | Registra un endpoint e i tipi di eventoidempotente |
| GET | /v1/webhooks/{id} | webhooks:read | Leggi un endpoint |
| PATCH | /v1/webhooks/{id} | webhooks:write | Modifica o riattiva un endpoint |
| DELETE | /v1/webhooks/{id} | webhooks:write | Elimina un endpoint |
| POST | /v1/webhooks/{id}/test | webhooks:write | Invia un evento webhook.testidempotente |
| GET | /v1/webhooks/{id}/deliveries | webhooks:read | Consegne di un endpoint |
| GET | /v1/webhooks/{id}/deliveries/{deliveryId} | webhooks:read | Una consegna con i suoi tentativi |
| POST | /v1/webhooks/{id}/deliveries/{deliveryId}/redeliver | webhooks:write | Invia di nuovo una consegnaidempotente |
| POST | /v1/webhooks/{id}/recover | webhooks:write | Reinvia le consegne non riusciteidempotente |
Report
| Metodo | Percorso | Scope | Scopo |
|---|---|---|---|
| POST | /v1/reports | analytics:read | Genera un report di statistiche in PDF o CSVidempotente |
| GET | /v1/reports | analytics:read | Elenca i report generati |
| GET | /v1/reports/{id} | analytics:read | Controlla un report e ottieni il link |
Hook Zapier e Make
| Metodo | Percorso | Scope | Scopo |
|---|---|---|---|
| GET | /v1/hooks | webhooks:read | Elenca gli hook di integrazione |
| POST | /v1/hooks | webhooks:write | Iscrivi un hook a un eventoidempotente |
| DELETE | /v1/hooks/{id} | webhooks:write | Annulla l’iscrizione di un hook |
| GET | /v1/hooks/samples/{event} | webhooks:read | Eventi recenti di un tipo, come esempio per un trigger |
Biglietti da visita
| Metodo | Percorso | Scope | Scopo |
|---|---|---|---|
| GET | /v1/cards | cards:read | Elenca i biglietti da visita del team |
| POST | /v1/cards | cards:write | Crea un biglietto da visitaidempotente |
| GET | /v1/cards/{id} | cards:read | Leggi un biglietto da visita |
| PATCH | /v1/cards/{id} | cards:write | Modifica un biglietto da visita |
| POST | /v1/cards/{id}/deactivate | cards:write | Disattiva un biglietto da visitaidempotente |
| GET | /v1/cards/{id}/analytics | cards:read | Visualizzazioni, salvataggi e tocchi di un biglietto |
Conversioni
| Metodo | Percorso | Scope | Scopo |
|---|---|---|---|
| POST | /v1/conversions | conversions:write | Registra una conversioneidempotente |
| GET | /v1/analytics/funnel | analytics:read | Funnel dalla scansione al ricavo |
Tag NFC
| Metodo | Percorso | Scope | Scopo |
|---|---|---|---|
| GET | /v1/nfc/tags | codes:read | Elenca i tag NFC |
| POST | /v1/nfc/tags | codes:write | Registra un tag NFC su un codiceidempotente |