Przejdź do treści
DOTWICK

Dokumentacja API

Trasy

Trasy niewymienione tutaj są tylko dla aplikacji i odpowiadają kluczowi 403 session_required. Trasy oznaczone jako idempotentne przyjmują Idempotency-Key.

Kody

MetodaŚcieżkaZakres (scope)Cel
GET/v1/codescodes:readLista kodów, filtrowanie według folderu, typu lub statusu
POST/v1/codescodes:writeUtwórz kodidempotentne
GET/v1/codes/{id}codes:readPobierz kod z jego wyglądem i regułami
PATCH/v1/codes/{id}codes:writeZmień adres docelowy, nazwę, wygląd i reguły
DELETE/v1/codes/{id}codes:writeUsuń kod (jego krótki link odpowiada 410)
POST/v1/codes/movecodes:writePrzenieś kody do folderuidempotentne
POST/v1/codes/move-domaincodes:writePrzenieś kody do innej domenyidempotentne
POST/v1/codes/tagscodes:writeDodaj lub usuń tagi w wielu kodachidempotentne
POST/v1/codes/{id}/duplicatecodes:writeZduplikuj kodidempotentne
PATCH/v1/codes/bulkcodes:writeWstrzymaj, wznów, zarchiwizuj, otaguj, przenieś lub usuń wiele kodów
GET/v1/utm-presetscodes:readLista zapisanych ustawień UTM
GET/v1/codes/{id}/versionscodes:readHistoria adresów docelowych kodu
GET/v1/codes/{id}/activitycodes:readStrumień aktywności kodu
GET/v1/codes/{id}/exportcodes:readPobierz jako SVG, PNG, JPG, PDF lub EPS
GET/v1/codes/{id}/hosted-statscodes:readLiczniki kodu hostowanego
GET/v1/codes/{id}/submissionssubmissions:readOdpowiedzi na kod z formularzem
GET/v1/codes/{id}/submissions/exportsubmissions:readOdpowiedzi z formularza jako CSV
GET/v1/gs1/productscodes:readLista produktów GS1 (kody gs1)
GET/v1/codes/{id}/gs1/qualifierscodes:readPoziomy partii, CPV i numeru seryjnego kodu GS1
GET/v1/codes/{id}/gs1/print-runscodes:readNakłady kodu GS1
GET/v1/codes/{id}/gs1/print-runs/{runId}codes:readSprawdź nakład i pobierz linki do plików

Zadania zbiorcze

MetodaŚcieżkaZakres (scope)Cel
POST/v1/codes/bulkcodes:writeUtwórz do 500 kodów w jednym zadaniuidempotentne
GET/v1/bulk-importscodes:readLista zadań zbiorczych
GET/v1/bulk-imports/{id}codes:readSprawdź zadanie zbiorcze
GET/v1/bulk-imports/{id}/rowscodes:readWiersze zadania zbiorczego
GET/v1/bulk-imports/{id}/results.csvcodes:readWyniki zadania jako CSV
POST/v1/bulk-imports/{id}/cancelcodes:writeAnuluj zadanie w kolejce lub w tokuidempotentne
POST/v1/bulk-imports/{id}/retrycodes:writePonów nieudane wiersze zadaniaidempotentne

Statystyki

MetodaŚcieżkaZakres (scope)Cel
GET/v1/analytics/summaryanalytics:readŁączna liczba skanów w okresie
GET/v1/analytics/timeseriesanalytics:readSkany w czasie
GET/v1/analytics/breakdownanalytics:readNajczęstsze kraje, urządzenia i więcej
GET/v1/analytics/scansanalytics:readRekordy poszczególnych skanów
GET/v1/analytics/sparklinesanalytics:readDzienne liczby dla kodów
GET/v1/analytics/compareanalytics:readPorównaj do 4 kodów
GET/v1/analytics/exportanalytics:readSkany jako CSV (krótkie okresy)
POST/v1/analytics/exportsanalytics:readSkany jako CSV, przygotowywane w tleidempotentne
GET/v1/codes/{id}/analytics/summaryanalytics:readSumy jednego kodu
GET/v1/codes/{id}/analytics/timeseriesanalytics:readJeden kod w czasie
GET/v1/codes/{id}/analytics/breakdownanalytics:readRankingi jednego kodu
GET/v1/codes/{id}/scansanalytics:readRekordy skanów jednego kodu
GET/v1/codes/{id}/gs1/batchesanalytics:readSkany według partii kodu GS1
GET/v1/codes/{id}/downloadsanalytics:readPobrania według pliku kodu Dokumenty
GET/v1/analytics/locationsanalytics:readMapa GPS skanów za zgodą
GET/v1/codes/{id}/analytics/locationsanalytics:readMapa GPS jednego kodu
GET/v1/alertsanalytics:readLista reguł alertów o skanach

Eksporty

MetodaŚcieżkaZakres (scope)Cel
POST/v1/exportscodes:readWyeksportuj wiele kodów jako jeden ZIPidempotentne
GET/v1/exportscodes:readLista eksportów
GET/v1/exports/{id}codes:readSprawdź eksport i pobierz link do ZIP

Foldery

MetodaŚcieżkaZakres (scope)Cel
GET/v1/foldersfolders:readLista folderów
POST/v1/foldersfolders:writeUtwórz folderidempotentne
GET/v1/folders/{id}folders:readPobierz folder
PATCH/v1/folders/{id}folders:writeZmień nazwę folderu lub go przenieś
DELETE/v1/folders/{id}folders:writeUsuń folder (kody przejdą poziom wyżej)

Szablony

MetodaŚcieżkaZakres (scope)Cel
GET/v1/templatestemplates:readLista szablonów wyglądu
POST/v1/templatestemplates:writeUtwórz szablonidempotentne
GET/v1/templates/{id}templates:readPobierz szablon
PATCH/v1/templates/{id}templates:writeZmień szablon
DELETE/v1/templates/{id}templates:writeUsuń szablon

Przesłane pliki

MetodaŚcieżkaZakres (scope)Cel
POST/v1/assetscodes:writePrześlij logo lub plik
GET/v1/assets/{id}codes:readPobierz przesłany plik z podpisanym adresem URL

Domeny

MetodaŚcieżkaZakres (scope)Cel
GET/v1/domainsdomains:readLista własnych domen
GET/v1/domains/{id}domains:readPobierz domenę i jej status
GET/v1/subdomaindomains:readSubdomena obszaru roboczego i jej linki
GET/v1/subdomain/availabilitydomains:readSprawdź, czy nazwa subdomeny jest wolna

Obszar roboczy

MetodaŚcieżkaZakres (scope)Cel
GET/v1/workspaces/currentdowolny kluczObszar roboczy klucza i jego plan
GET/v1/usagedowolny kluczLimity planu i zużycie w tym miesiącu

Webhooki

MetodaŚcieżkaZakres (scope)Cel
GET/v1/webhookswebhooks:readLista endpointów webhooków
POST/v1/webhookswebhooks:writeZarejestruj endpoint i typy zdarzeńidempotentne
GET/v1/webhooks/{id}webhooks:readPobierz endpoint
PATCH/v1/webhooks/{id}webhooks:writeZmień lub ponownie włącz endpoint
DELETE/v1/webhooks/{id}webhooks:writeUsuń endpoint
POST/v1/webhooks/{id}/testwebhooks:writeWyślij zdarzenie webhook.testidempotentne
GET/v1/webhooks/{id}/deliverieswebhooks:readDostarczenia endpointu
GET/v1/webhooks/{id}/deliveries/{deliveryId}webhooks:readDostarczenie wraz z próbami
POST/v1/webhooks/{id}/deliveries/{deliveryId}/redeliverwebhooks:writeWyślij dostarczenie ponownieidempotentne
POST/v1/webhooks/{id}/recoverwebhooks:writeWyślij ponownie nieudane dostarczeniaidempotentne

Tagi

MetodaŚcieżkaZakres (scope)Cel
GET/v1/tagstags:readLista tagów
POST/v1/tagstags:writeUtwórz tagidempotentne
GET/v1/tags/{id}tags:readPobierz tag
PATCH/v1/tags/{id}tags:writeZmień nazwę lub kolor tagu
DELETE/v1/tags/{id}tags:writeUsuń tag (zostanie usunięty z jego kodów)

Raporty

MetodaŚcieżkaZakres (scope)Cel
POST/v1/reportsanalytics:readWygeneruj raport statystyk w PDF lub CSVidempotentne
GET/v1/reportsanalytics:readLista wygenerowanych raportów
GET/v1/reports/{id}analytics:readSprawdź raport i pobierz link

Hooki Zapier i Make

MetodaŚcieżkaZakres (scope)Cel
GET/v1/hookswebhooks:readLista hooków integracji
POST/v1/hookswebhooks:writeZapisz hook na jedno zdarzenieidempotentne
DELETE/v1/hooks/{id}webhooks:writeWypisz hook
GET/v1/hooks/samples/{event}webhooks:readOstatnie zdarzenia danego typu, jako próbka dla wyzwalacza

Wizytówki

MetodaŚcieżkaZakres (scope)Cel
GET/v1/cardscards:readLista wizytówek zespołu
POST/v1/cardscards:writeUtwórz wizytówkęidempotentne
GET/v1/cards/{id}cards:readPobierz wizytówkę
PATCH/v1/cards/{id}cards:writeZmień wizytówkę
POST/v1/cards/{id}/deactivatecards:writeDezaktywuj wizytówkęidempotentne
GET/v1/cards/{id}/analyticscards:readWyświetlenia, zapisy i stuknięcia wizytówki

Konwersje

MetodaŚcieżkaZakres (scope)Cel
POST/v1/conversionsconversions:writeZapisz konwersjęidempotentne
GET/v1/analytics/funnelanalytics:readLejek od skanu do przychodu

Tagi NFC

MetodaŚcieżkaZakres (scope)Cel
GET/v1/nfc/tagscodes:readLista tagów NFC
POST/v1/nfc/tagscodes:writeZarejestruj tag NFC w kodzieidempotentne