Pular para o conteúdo
DOTWICK

Docs

A API da Dotwick

REST sobre JSON. Crie um código, mude para onde ele vai e receba um webhook assinado quando alguém o escanear. A referência abaixo é gerada dos mesmos contratos com que a API valida. Não precisa de SDK: todo exemplo é curl, JavaScript ou Python.

Primeiros passos

Primeiros passosInício rápidoTrês passos: crie uma chave no app, crie um código e escaneie o link curto que ele devolve.Primeiros passosAutenticaçãoEnvie a sua chave secreta como bearer token. As chaves têm escopos e agem com a função de quem as criou em um único espaço de trabalho, no máximo como Editor.Primeiros passosErrosOs erros são JSON com um código estável para ramificar, uma mensagem legível e um ID de requisição para o suporte.

Códigos

Códigos / Criar um códigoCriar um códigoCria um código e o devolve com o seu link curto. O destino de um código dinâmico pode ser mudado depois com PATCH sem mexer no código impresso.Códigos / Listar códigosListar códigosLista os códigos que a chave pode ver, os mais novos primeiro, uma página por vez. Filtre por pasta, tipo, status ou termo de busca.Códigos / Atualizar um códigoAtualizar um códigoMuda o destino, o nome, o design, as regras, a pasta ou o status de um código. O link curto e toda cópia impressa continuam funcionando: só muda para onde apontam.Códigos / Criação em massaCriação em massaCria até 500 códigos de um tipo em uma requisição, como uma execução em segundo plano que você pode acompanhar: as mesmas execuções de um envio de CSV no app.

Estatísticas

EstatísticasComparar e exportarColoque até 4 códigos lado a lado no mesmo período e baixe os escaneamentos como arquivo CSV. As duas coisas exigem uma chave com analytics:read.

Webhooks

Webhooks / Registrar um endpointRegistrar um endpointRegistre um endpoint https e escolha os eventos. Enviamos cada evento com POST como JSON, assinado, e tentamos de novo até ele responder 2xx.Webhooks / Tipos de eventoTipos de eventoTodo evento compartilha um só envelope. data traz os mesmos objetos que a API devolve, então um só parser serve para os dois.Webhooks / Verificação de assinaturasVerificação de assinaturasAs entregas são assinadas conforme a especificação Standard Webhooks. Confira a assinatura antes de confiar em um payload.

Conversões

ConversõesPixel de conversãoConte visitas e pedidos depois de um escaneamento. Um pequeno script no seu site guarda o ID de clique e informa a meta, com consentimento e sem dados pessoais.ConversõesPostback do servidorInforme uma conversão do seu servidor quando o pedido for confirmado ou o pixel não carregou. Envie o ID de clique, o evento e, se houver, um valor.

Integrações

IntegraçõesZapierEnvie escaneamentos, formulários e novos códigos aos apps do Zapier e crie ou mude códigos a partir de um Zap. O app da Dotwick para o Zapier usa uma chave de API.IntegraçõesMakeRode cenários do Make com escaneamentos, formulários e novos códigos e crie ou mude códigos a partir de um cenário. O app da Dotwick para o Make usa uma chave de API.IntegraçõesShopifyVeja a receita que cada QR code traz para a sua loja Shopify. O app lê os totais dos pedidos e o ID de clique, nunca quem é o cliente. Listagem em breve.IntegraçõesSlackEnvie alertas de escaneamento e um resumo semanal para um canal do Slack, e crie ou confira códigos com /dotwick. A listagem no Slack chega em breve.IntegraçõesHubSpot e SalesforceCrie contatos no HubSpot e leads no Salesforce a partir de formulários e cartões de visita, e veja os escaneamentos de um código na linha do tempo. Listagens em breve.

Cartões de visita

Cartões de visitaSincronização de cartões SCIMMantenha cada cartão de visita da equipe em sintonia com o seu diretório. Okta, Microsoft Entra ID e Google Workspace criam, atualizam e desativam cartões via SCIM.

Apps

AppsApp mobileGerencie seus códigos pelo celular: escaneie, crie, confira escaneamentos e mostre o seu próprio cartão de visita. Os apps para iOS e Android chegam em breve.AppsExtensão do ChromeCrie um QR code para a página em que você está, pelo navegador. A extensão chega em breve à Chrome Web Store.

Assistentes de IA

Assistentes de IAServidor MCPConecte o Claude, o ChatGPT ou um agente de programação ao seu espaço da Dotwick com uma chave de API. Ele pode listar e criar códigos, etiquetá-los e ler escaneamentos.

Referência

ReferênciaReferência da APIToda rota que uma chave de API pode chamar, com seu escopo. URL base https://api.dotwick.com, documento OpenAPI em https://api.dotwick.com/openapi.json.ReferênciaLimites de requisiçõesOs limites são por espaço de trabalho, compartilhados por todas as chaves de API dentro dele, e crescem com o plano.ReferênciaPaginaçãoAs listas são paginadas por cursor: { data, nextCursor }, as mais novas primeiro, salvo se uma ordenação disser o contrário.ReferênciaIdempotênciaEnvie um Idempotency-Key com um POST e repeti-lo nunca fará o trabalho duas vezes.ReferênciaVersionamentoUma só versão, v1, sob /v1. Ela só cresce; nada nela muda nem desaparece sem um ano de aviso.ReferênciaChangelogToda adição e toda descontinuação da API, as mais novas primeiro. Os cabeçalhos de descontinuação apontam para cá.