Pular para o conteúdo
DOTWICK

Referência da API

Rotas

As rotas que não estão listadas aqui são só para o app e respondem a uma chave com 403 session_required. As rotas marcadas como idempotentes aceitam um Idempotency-Key.

Códigos

MétodoCaminhoEscopoFinalidade
GET/v1/codescodes:readLista os códigos, com filtro por pasta, tipo ou status
POST/v1/codescodes:writeCria um códigoidempotente
GET/v1/codes/{id}codes:readBusca um código com seu design e suas regras
PATCH/v1/codes/{id}codes:writeAltera destino, nome, design e regras
DELETE/v1/codes/{id}codes:writeExclui um código (o link curto responde 410)
POST/v1/codes/movecodes:writeMove códigos para uma pastaidempotente
POST/v1/codes/move-domaincodes:writeMove códigos para outro domínioidempotente
POST/v1/codes/tagscodes:writeAdiciona ou remove tags em vários códigosidempotente
POST/v1/codes/{id}/duplicatecodes:writeDuplica um códigoidempotente
PATCH/v1/codes/bulkcodes:writePausa, retoma, arquiva, marca com tags, move ou exclui vários códigos
GET/v1/utm-presetscodes:readLista as predefinições de UTM salvas
GET/v1/codes/{id}/versionscodes:readHistórico de destinos de um código
GET/v1/codes/{id}/activitycodes:readFeed de atividades de um código
GET/v1/codes/{id}/exportcodes:readBaixa em SVG, PNG, JPG, PDF ou EPS
GET/v1/codes/{id}/hosted-statscodes:readContadores de um código hospedado
GET/v1/codes/{id}/submissionssubmissions:readRespostas a um código de formulário
GET/v1/codes/{id}/submissions/exportsubmissions:readRespostas do formulário em CSV
GET/v1/gs1/productscodes:readLista os produtos GS1 (os códigos gs1)
GET/v1/codes/{id}/gs1/qualifierscodes:readNíveis de lote, CPV e serial de um código GS1
GET/v1/codes/{id}/gs1/print-runscodes:readTiragens de um código GS1
GET/v1/codes/{id}/gs1/print-runs/{runId}codes:readConsulta uma tiragem e obtém os links dos arquivos

Execuções em massa

MétodoCaminhoEscopoFinalidade
POST/v1/codes/bulkcodes:writeCria até 500 códigos em uma única execuçãoidempotente
GET/v1/bulk-importscodes:readLista as execuções em massa
GET/v1/bulk-imports/{id}codes:readConsulta uma execução em massa
GET/v1/bulk-imports/{id}/rowscodes:readLinhas de uma execução em massa
GET/v1/bulk-imports/{id}/results.csvcodes:readResultados de uma execução em CSV
POST/v1/bulk-imports/{id}/cancelcodes:writeCancela uma execução na fila ou em andamentoidempotente
POST/v1/bulk-imports/{id}/retrycodes:writeTenta de novo as linhas com falha de uma execuçãoidempotente

Estatísticas

MétodoCaminhoEscopoFinalidade
GET/v1/analytics/summaryanalytics:readTotais de escaneamentos em um período
GET/v1/analytics/timeseriesanalytics:readEscaneamentos ao longo do tempo
GET/v1/analytics/breakdownanalytics:readPrincipais países, dispositivos e mais
GET/v1/analytics/scansanalytics:readRegistros de cada escaneamento
GET/v1/analytics/sparklinesanalytics:readContagens diárias por código
GET/v1/analytics/compareanalytics:readCompara até 4 códigos
GET/v1/analytics/exportanalytics:readEscaneamentos em CSV (períodos curtos)
POST/v1/analytics/exportsanalytics:readEscaneamentos em CSV, preparados em segundo planoidempotente
GET/v1/codes/{id}/analytics/summaryanalytics:readTotais de um código
GET/v1/codes/{id}/analytics/timeseriesanalytics:readUm código ao longo do tempo
GET/v1/codes/{id}/analytics/breakdownanalytics:readOs rankings de um código
GET/v1/codes/{id}/scansanalytics:readRegistros de cada escaneamento de um código
GET/v1/codes/{id}/gs1/batchesanalytics:readEscaneamentos por lote de um código GS1
GET/v1/codes/{id}/downloadsanalytics:readDownloads por arquivo de um código de Documentos
GET/v1/analytics/locationsanalytics:readMapa GPS dos escaneamentos com consentimento
GET/v1/codes/{id}/analytics/locationsanalytics:readMapa GPS de um código
GET/v1/alertsanalytics:readLista as regras de alerta de escaneamento

Exportações

MétodoCaminhoEscopoFinalidade
POST/v1/exportscodes:readExporta vários códigos em um único ZIPidempotente
GET/v1/exportscodes:readLista as exportações
GET/v1/exports/{id}codes:readConsulta uma exportação e obtém o link do ZIP

Pastas

MétodoCaminhoEscopoFinalidade
GET/v1/foldersfolders:readLista as pastas
POST/v1/foldersfolders:writeCria uma pastaidempotente
GET/v1/folders/{id}folders:readBusca uma pasta
PATCH/v1/folders/{id}folders:writeRenomeia ou move uma pasta
DELETE/v1/folders/{id}folders:writeExclui uma pasta (os códigos sobem um nível)

Modelos

MétodoCaminhoEscopoFinalidade
GET/v1/templatestemplates:readLista os modelos de design
POST/v1/templatestemplates:writeCria um modeloidempotente
GET/v1/templates/{id}templates:readBusca um modelo
PATCH/v1/templates/{id}templates:writeAltera um modelo
DELETE/v1/templates/{id}templates:writeExclui um modelo

Uploads

MétodoCaminhoEscopoFinalidade
POST/v1/assetscodes:writeEnvia um logo ou um arquivo
GET/v1/assets/{id}codes:readBusca um upload com uma URL assinada

Domínios

MétodoCaminhoEscopoFinalidade
GET/v1/domainsdomains:readLista os domínios personalizados
GET/v1/domains/{id}domains:readBusca um domínio e seu status
GET/v1/subdomaindomains:readO subdomínio do espaço de trabalho e seus links
GET/v1/subdomain/availabilitydomains:readVerifica se um nome de subdomínio está livre

Espaço de trabalho

MétodoCaminhoEscopoFinalidade
GET/v1/workspaces/currentqualquer chaveO espaço de trabalho da chave e o plano
GET/v1/usagequalquer chaveLimites do plano e uso neste mês

Webhooks

MétodoCaminhoEscopoFinalidade
GET/v1/webhookswebhooks:readLista os endpoints de webhook
POST/v1/webhookswebhooks:writeRegistra um endpoint e os tipos de eventoidempotente
GET/v1/webhooks/{id}webhooks:readBusca um endpoint
PATCH/v1/webhooks/{id}webhooks:writeAltera ou reativa um endpoint
DELETE/v1/webhooks/{id}webhooks:writeExclui um endpoint
POST/v1/webhooks/{id}/testwebhooks:writeEnvia um evento webhook.testidempotente
GET/v1/webhooks/{id}/deliverieswebhooks:readEntregas de um endpoint
GET/v1/webhooks/{id}/deliveries/{deliveryId}webhooks:readUma entrega com suas tentativas
POST/v1/webhooks/{id}/deliveries/{deliveryId}/redeliverwebhooks:writeEnvia uma entrega de novoidempotente
POST/v1/webhooks/{id}/recoverwebhooks:writeReenvia as entregas com falhaidempotente

Tags

MétodoCaminhoEscopoFinalidade
GET/v1/tagstags:readLista as tags
POST/v1/tagstags:writeCria uma tagidempotente
GET/v1/tags/{id}tags:readBusca uma tag
PATCH/v1/tags/{id}tags:writeRenomeia uma tag ou muda sua cor
DELETE/v1/tags/{id}tags:writeExclui uma tag (ela é removida dos seus códigos)

Relatórios

MétodoCaminhoEscopoFinalidade
POST/v1/reportsanalytics:readGera um relatório de estatísticas em PDF ou CSVidempotente
GET/v1/reportsanalytics:readLista os relatórios gerados
GET/v1/reports/{id}analytics:readConsulta um relatório e obtém o link

Hooks do Zapier e do Make

MétodoCaminhoEscopoFinalidade
GET/v1/hookswebhooks:readLista os hooks de integração
POST/v1/hookswebhooks:writeInscreve um hook em um eventoidempotente
DELETE/v1/hooks/{id}webhooks:writeCancela a inscrição de um hook
GET/v1/hooks/samples/{event}webhooks:readEventos recentes de um tipo, como amostra para um gatilho

Cartões de visita

MétodoCaminhoEscopoFinalidade
GET/v1/cardscards:readLista os cartões de visita da equipe
POST/v1/cardscards:writeCria um cartão de visitaidempotente
GET/v1/cards/{id}cards:readBusca um cartão de visita
PATCH/v1/cards/{id}cards:writeAltera um cartão de visita
POST/v1/cards/{id}/deactivatecards:writeDesativa um cartão de visitaidempotente
GET/v1/cards/{id}/analyticscards:readVisualizações, salvamentos e toques de um cartão

Conversões

MétodoCaminhoEscopoFinalidade
POST/v1/conversionsconversions:writeRegistra uma conversãoidempotente
GET/v1/analytics/funnelanalytics:readFunil do escaneamento à receita

Tags NFC

MétodoCaminhoEscopoFinalidade
GET/v1/nfc/tagscodes:readLista as tags NFC
POST/v1/nfc/tagscodes:writeRegistra uma tag NFC em um códigoidempotente