Aller au contenu

Démarrage rapide

1. Obtenir une clé

Dans l’application, ouvrez Settings → API et choisissez New key. Sélectionnez les scopes dont l’intégration a besoin (codes:read et codes:write suffisent ici). Le secret commence par sk_live_ et n’est affiché qu’une fois : conservez-le dans les secrets de votre serveur, jamais dans un navigateur ni dans une application mobile.

L’API est incluse dans Pro, Business et Enterprise. Il n’existe pas de mode test séparé : utilisez un second espace de travail pour vos essais.

2. Créer un code

Envoyez la destination en POST à /v1/codes avec votre clé comme jeton bearer et un Idempotency-Key, pour qu’une requête rejouée ne crée jamais de doublon.

requêtePOST /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"  }'
réponse201 Createdextrait : l’objet complet contient aussi le design, les règles et les horodatages
{  "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. Tester

Le shortUrl de la réponse fonctionne immédiatement. Scannez-le ou ouvrez-le dans un navigateur : il redirige vers votre destination et le scan apparaît dans les statistiques en quelques secondes.

Ensuite : changez la destination avec PATCH /v1/codes/{id}, ou enregistrez un webhook pour être informé de chaque scan.