Pular para o conteúdo

Início rápido

1. Obtenha uma chave

No app, abra Settings → API e escolha New key. Escolha os escopos de que a integração precisa (codes:read e codes:write bastam aqui). O segredo começa com sk_live_ e é mostrado uma vez: guarde-o nos segredos do seu servidor, nunca em um navegador ou app mobile.

A API está incluída no Pro, no Business e no Enterprise. Não há um modo de teste separado: use um segundo espaço de trabalho para experimentos.

2. Crie um código

Envie com POST o destino para /v1/codes com a sua chave como bearer token e um Idempotency-Key, para que uma requisição repetida nunca crie um duplicado.

requisiçãoPOST /v1/codes
curl -X POST https://api.dotwick.com/v1/codes \  -H "Authorization: Bearer sk_live_…" \  -H "Content-Type: application/json" \  -H "Idempotency-Key: van-014-2026-09-10" \  -d '{    "name": "Van fleet – unit 14",    "content": {      "type": "url",      "url": "https://example.com/fleet/van-014"    },    "design": {      "pattern": "rounded",      "eyes": {        "frame": "circle",        "ball": "circle"      },      "colors": {        "fg": "#18181B",        "bg": "#FFFFFF"      }    },    "folderId": "fld_8k2m4q7x"  }'
resposta201 Createdtrecho: o objeto completo também traz design, regras e carimbos de data e hora
{  "id": "qr_8841ce2mxk",  "name": "Van fleet – unit 14",  "type": "url",  "dynamic": true,  "status": "active",  "slug": "Xq7mK2p",  "shortUrl": "https://dotwick.co/Xq7mK2p",  "content": {    "type": "url",    "url": "https://example.com/fleet/van-014"  },  "folderId": "fld_8k2m4q7x",  "createdAt": "2026-09-10T09:41:08.000Z"}

3. Teste

O shortUrl da resposta funciona na hora. Escaneie ou abra em um navegador: ele redireciona para o seu destino e o escaneamento aparece nas estatísticas em poucos segundos.

Depois: mude o destino com PATCH /v1/codes/{id} ou registre um webhook para saber de cada escaneamento.