Naar de inhoud
DOTWICK

API-referentie

Routes

Routes die hier niet staan, zijn alleen voor de app en antwoorden een sleutel met 403 session_required. Routes die als idempotent zijn gemarkeerd, accepteren een Idempotency-Key.

Codes

MethodePadScopeDoel
GET/v1/codescodes:readCodes ophalen, filteren op map, type of status
POST/v1/codescodes:writeEen code aanmakenidempotent
GET/v1/codes/{id}codes:readEen code ophalen met ontwerp en regels
PATCH/v1/codes/{id}codes:writeBestemming, naam, ontwerp en regels wijzigen
DELETE/v1/codes/{id}codes:writeEen code verwijderen (de korte link antwoordt met 410)
POST/v1/codes/movecodes:writeCodes naar een map verplaatsenidempotent
POST/v1/codes/move-domaincodes:writeCodes naar een ander domein verplaatsenidempotent
POST/v1/codes/tagscodes:writeTags toevoegen of verwijderen bij veel codesidempotent
POST/v1/codes/{id}/duplicatecodes:writeEen code duplicerenidempotent
PATCH/v1/codes/bulkcodes:writeVeel codes pauzeren, hervatten, archiveren, taggen, verplaatsen of verwijderen
GET/v1/utm-presetscodes:readOpgeslagen UTM-presets ophalen
GET/v1/codes/{id}/versionscodes:readBestemmingsgeschiedenis van een code
GET/v1/codes/{id}/activitycodes:readActiviteitenfeed van een code
GET/v1/codes/{id}/exportcodes:readDownloaden als SVG, PNG, JPG, PDF of EPS
GET/v1/codes/{id}/hosted-statscodes:readTellers van een gehoste code
GET/v1/codes/{id}/submissionssubmissions:readAntwoorden op een formuliercode
GET/v1/codes/{id}/submissions/exportsubmissions:readFormulierantwoorden als CSV
GET/v1/gs1/productscodes:readGS1-producten ophalen (de gs1-codes)
GET/v1/codes/{id}/gs1/qualifierscodes:readBatch-, CPV- en serieniveaus van een GS1-code
GET/v1/codes/{id}/gs1/print-runscodes:readDrukruns van een GS1-code
GET/v1/codes/{id}/gs1/print-runs/{runId}codes:readEen drukrun opvragen en de bestandslinks ophalen

Bulkruns

MethodePadScopeDoel
POST/v1/codes/bulkcodes:writeTot 500 codes aanmaken als één runidempotent
GET/v1/bulk-importscodes:readBulkruns ophalen
GET/v1/bulk-imports/{id}codes:readEen bulkrun opvragen
GET/v1/bulk-imports/{id}/rowscodes:readRijen van een bulkrun
GET/v1/bulk-imports/{id}/results.csvcodes:readResultaten van een run als CSV
POST/v1/bulk-imports/{id}/cancelcodes:writeEen run in de wachtrij of lopende run annulerenidempotent
POST/v1/bulk-imports/{id}/retrycodes:writeDe mislukte rijen van een run opnieuw proberenidempotent

Analyse

MethodePadScopeDoel
GET/v1/analytics/summaryanalytics:readTotaal aantal scans voor een periode
GET/v1/analytics/timeseriesanalytics:readScans in de tijd
GET/v1/analytics/breakdownanalytics:readTop-landen, -apparaten en meer
GET/v1/analytics/scansanalytics:readRecords per scan
GET/v1/analytics/sparklinesanalytics:readDagelijkse aantallen voor codes
GET/v1/analytics/compareanalytics:readTot 4 codes vergelijken
GET/v1/analytics/exportanalytics:readScans als CSV (korte periodes)
POST/v1/analytics/exportsanalytics:readScans als CSV, op de achtergrond voorbereididempotent
GET/v1/codes/{id}/analytics/summaryanalytics:readTotalen van één code
GET/v1/codes/{id}/analytics/timeseriesanalytics:readEén code in de tijd
GET/v1/codes/{id}/analytics/breakdownanalytics:readToplijsten van één code
GET/v1/codes/{id}/scansanalytics:readRecords per scan van één code
GET/v1/codes/{id}/gs1/batchesanalytics:readScans per batch van een GS1-code
GET/v1/codes/{id}/downloadsanalytics:readDownloads per bestand van een Documenten-code
GET/v1/analytics/locationsanalytics:readGPS-kaart van scans met toestemming
GET/v1/codes/{id}/analytics/locationsanalytics:readGPS-kaart van één code
GET/v1/alertsanalytics:readRegels voor scanmeldingen ophalen

Exports

MethodePadScopeDoel
POST/v1/exportscodes:readVeel codes exporteren als één ZIPidempotent
GET/v1/exportscodes:readExports ophalen
GET/v1/exports/{id}codes:readEen export opvragen en de ZIP-link ophalen

Mappen

MethodePadScopeDoel
GET/v1/foldersfolders:readMappen ophalen
POST/v1/foldersfolders:writeEen map aanmakenidempotent
GET/v1/folders/{id}folders:readEen map ophalen
PATCH/v1/folders/{id}folders:writeEen map hernoemen of verplaatsen
DELETE/v1/folders/{id}folders:writeEen map verwijderen (codes gaan een niveau omhoog)

Sjablonen

MethodePadScopeDoel
GET/v1/templatestemplates:readOntwerpsjablonen ophalen
POST/v1/templatestemplates:writeEen sjabloon aanmakenidempotent
GET/v1/templates/{id}templates:readEen sjabloon ophalen
PATCH/v1/templates/{id}templates:writeEen sjabloon wijzigen
DELETE/v1/templates/{id}templates:writeEen sjabloon verwijderen

Uploads

MethodePadScopeDoel
POST/v1/assetscodes:writeEen logo of bestand uploaden
GET/v1/assets/{id}codes:readEen upload ophalen met een ondertekende URL

Domeinen

MethodePadScopeDoel
GET/v1/domainsdomains:readEigen domeinen ophalen
GET/v1/domains/{id}domains:readEen domein en zijn status ophalen
GET/v1/subdomaindomains:readHet subdomein van de werkruimte en de bijbehorende links
GET/v1/subdomain/availabilitydomains:readControleren of een subdomeinnaam vrij is

Werkruimte

MethodePadScopeDoel
GET/v1/workspaces/currentelke sleutelDe werkruimte en het abonnement van de sleutel
GET/v1/usageelke sleutelAbonnementslimieten en gebruik deze maand

Webhooks

MethodePadScopeDoel
GET/v1/webhookswebhooks:readWebhook-endpoints ophalen
POST/v1/webhookswebhooks:writeEen endpoint en eventtypen registrerenidempotent
GET/v1/webhooks/{id}webhooks:readEen endpoint ophalen
PATCH/v1/webhooks/{id}webhooks:writeEen endpoint wijzigen of weer inschakelen
DELETE/v1/webhooks/{id}webhooks:writeEen endpoint verwijderen
POST/v1/webhooks/{id}/testwebhooks:writeEen webhook.test-event sturenidempotent
GET/v1/webhooks/{id}/deliverieswebhooks:readLeveringen van een endpoint
GET/v1/webhooks/{id}/deliveries/{deliveryId}webhooks:readEen levering met zijn pogingen
POST/v1/webhooks/{id}/deliveries/{deliveryId}/redeliverwebhooks:writeEen levering opnieuw sturenidempotent
POST/v1/webhooks/{id}/recoverwebhooks:writeMislukte leveringen opnieuw sturenidempotent

Tags

MethodePadScopeDoel
GET/v1/tagstags:readTags ophalen
POST/v1/tagstags:writeEen tag aanmakenidempotent
GET/v1/tags/{id}tags:readEen tag ophalen
PATCH/v1/tags/{id}tags:writeEen tag hernoemen of van kleur veranderen
DELETE/v1/tags/{id}tags:writeEen tag verwijderen (wordt bij zijn codes verwijderd)

Rapporten

MethodePadScopeDoel
POST/v1/reportsanalytics:readEen PDF- of CSV-analyserapport genererenidempotent
GET/v1/reportsanalytics:readGegenereerde rapporten ophalen
GET/v1/reports/{id}analytics:readEen rapport opvragen en de link ophalen

Zapier- en Make-hooks

MethodePadScopeDoel
GET/v1/hookswebhooks:readIntegratiehooks ophalen
POST/v1/hookswebhooks:writeEen hook abonneren op één eventidempotent
DELETE/v1/hooks/{id}webhooks:writeEen hook afmelden
GET/v1/hooks/samples/{event}webhooks:readRecente events van een type, als voorbeeld voor een trigger

Visitekaartjes

MethodePadScopeDoel
GET/v1/cardscards:readVisitekaartjes van het team ophalen
POST/v1/cardscards:writeEen visitekaartje aanmakenidempotent
GET/v1/cards/{id}cards:readEen visitekaartje ophalen
PATCH/v1/cards/{id}cards:writeEen visitekaartje wijzigen
POST/v1/cards/{id}/deactivatecards:writeEen visitekaartje deactiverenidempotent
GET/v1/cards/{id}/analyticscards:readWeergaven, opslagen en tikken van een kaartje

Conversies

MethodePadScopeDoel
POST/v1/conversionsconversions:writeEen conversie registrerenidempotent
GET/v1/analytics/funnelanalytics:readFunnel van scan tot omzet

NFC-tags

MethodePadScopeDoel
GET/v1/nfc/tagscodes:readNFC-tags ophalen
POST/v1/nfc/tagscodes:writeEen NFC-tag registreren op een codeidempotent