Introduction à l'API

​

Ce que vous pouvez faire

​

Guides

​

URL de base

https://getqr.com/api/v1

​

Versionnement

• Les changements incompatibles sortent sous un nouveau préfixe de version, par exemple /api/v2/, et /api/v1/ continue de fonctionner.
• Des ajouts compatibles, comme de nouveaux champs facultatifs ou de nouveaux endpoints, peuvent apparaître dans la v1. Ignorez les champs de réponse que votre code ne connaît pas.

​

Démarrage rapide

curl https://getqr.com/api/v1/health

curl -X POST "https://getqr.com/api/v1/qrs" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: first-qr-0001" \
  -d '{
    "qrType": "website",
    "data": "https://example.com",
    "title": "Landing page"
  }'

curl "https://getqr.com/api/v1/qrs/{qrId}/download?format=png&resolution=1024" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  --output qr-code.png

​

Requêtes et réponses

• Format. Envoyez les corps de requête en JSON avec Content-Type: application/json. Seule exception : l’import CSV de la création en masse, qui utilise multipart/form-data.
• Réponses. Les réponses sont en JSON. Les téléchargements, comme les images de QR codes et les archives ZIP de création en masse, renvoient le fichier lui-même.
• Dates. Les dates sont des chaînes ISO 8601 en UTC, par exemple 2026-08-01T10:00:00.000Z.
• Paramètres de requête. Les paramètres booléens prennent les chaînes true ou false.
• Mises à jour partielles. Les endpoints PATCH ne modifient que les champs que vous envoyez.
• Secrets. Les réponses n’incluent jamais de mots de passe ni d’identifiants internes. Un QR code protégé par mot de passe indique seulement passwordProtected: true.
• Espace de travail. Chaque requête s’exécute dans l’espace de travail auquel appartient votre clé API. Vous ne transmettez pas d’identifiant d’espace de travail. Consultez Accès et rôles.
• Erreurs. Les requêtes en échec renvoient un objet error avec un code stable. Consultez Erreurs.

​

Pagination

{
  "data": [ … ],
  "pagination": { "page": 1, "pageSize": 50, "total": 128, "hasMore": true }
}

​

Idempotence

-H "Idempotency-Key: order-4821-qr"

• Répéter la requête avec la même clé dans les 24 heures renvoie la réponse d’origine au lieu de créer un second QR code.
• L’en-tête de réponse x-idempotent-replay vaut true pour une réponse rejouée et false pour une nouvelle.
• Si la première requête avec cette clé est encore en cours, l’API répond 409 conflict. Réessayez une fois qu’elle est terminée.
• Réutiliser une clé avec un autre corps de requête renvoie 422 unprocessable_entity.
• Sans cet en-tête, un corps de requête identique envoyé dans les 30 secondes est traité comme un doublon.

​

Limites de débit

​

Prochainement

​

Et ensuite