Une API QR pour gérer les ressources de campagne

Créez des ressources, modifiez leurs destinations et consultez les rapports sans contourner les permissions d’espace de travail ni les limites de l’offre.

Obtenez votre jeton API
Voir en Markdown
requests.post(
  'https://qrcodetransfer.com/api/v1/workspaces/ID/assets',
  headers={'Authorization': 'Bearer YOUR_KEY'},
  json=data,
  timeout=10
)
Exemple de QR code

DOCIntroduction

Construisez votre flux autour des QR codes, liens courts, pages, formulaires et liens GS1 appartenant à l’espace de travail. L’API applique les mêmes contrôles de propriété, validations et quotas que l’espace utilisateur. Commencez par une ressource de test avant d’automatiser un lot.

URL de base

https://qrcodetransfer.com/api/v1/

Les données restent privées. Chaque requête vérifie l’espace et les droits de l’utilisateur ou de la clé API.

AUTHAuthentification

Créez une clé si votre offre inclut l’API. Gardez-la sur votre serveur. Chaque clé appartient à un espace et dispose de droits de lecture ou d’écriture.

Authorization: Bearer YOUR_API_KEY

QRCodes QR

Un code dynamique conserve son adresse imprimée quand la destination change. Un code statique contient directement le contenu et ne peut changer de destination.

POST /api/v1/workspaces/WORKSPACE_ID/assets

{
  "kind": "QRCODE",
  "name": "Spring campaign",
  "payload": {
    "type": "LINK",
    "url": "https://example.com/campaign",
    "dynamic": true
  }
}

PDFQR codes PDF

Importez le PDF puis créez un QR code avec son identifiant. Une nouvelle version laisse l’ancienne disponible jusqu’à la mise à jour de la ressource. Les fichiers non publiés nécessitent une authentification.

POST /api/v1/workspaces/WORKSPACE_ID/files
Content-Type: multipart/form-data

POST /api/v1/workspaces/WORKSPACE_ID/assets
{ "kind": "QRCODE", "name": "Product guide",
  "payload": { "type": "PDF", "fileId": 123, "dynamic": true } }

PAGEPages de destination

Les pages commencent en brouillon. Ajoutez titre et liens puis publiez. Modifier le brouillon ne change pas la version publique avant une nouvelle publication.

POST /api/v1/workspaces/WORKSPACE_ID/assets
{ "kind": "PAGE", "name": "Our links", "payload": {
  "title": "Our links",
  "links": [{ "label": "Website", "url": "https://example.com" }]
} }

POST /api/v1/workspaces/WORKSPACE_ID/assets/ASSET_ID/actions/publish

FORMFormulaires

Chaque réponse conserve les champs publiés. Utilisez les identifiants de champs. Une clé d’idempotence évite les doublons en renvoyant le résultat initial. Un formulaire fermé reste visible mais n’accepte plus de réponses.

POST /api/public/forms/FORM_SLUG/submissions
{ "answers": { "email": "[email protected]" },
  "idempotencyKey": "submission-unique-id" }

GS1GS1 Digital Link

Les codes produits incluent un identifiant d’application dans l’URI. Vérifiez-le avant impression. L’identité reste fixe quand la destination change. Testez le code dans votre processus de vente et d’emballage.

POST /api/v1/workspaces/WORKSPACE_ID/assets
{ "kind": "GS1", "name": "Product", "payload": {
  "identifierType": "01", "identifierValue": "09506000134369",
  "destinationUrl": "https://example.com/product"
} }

BULKCréation en lot

Prévisualisez les lignes avant création. Les URL invalides et chemins réservés sont signalés. Réutilisez la même Idempotency-Key pour éviter de recréer les lignes réussies.

POST /api/v1/workspaces/WORKSPACE_ID/bulk/preview
POST /api/v1/workspaces/WORKSPACE_ID/bulk/execute
Idempotency-Key: unique-batch-id

{ "kind": "SHORTLINK", "rows": [
  { "name": "Launch", "url": "https://example.com/launch" }
] }

HOOKWebhooks

Les propriétaires peuvent gérer les webhooks si leur offre le permet. L’envoi doit être activé et configuré. Les journaux montrent le résultat réel ; enregistrer un endpoint ne signifie pas qu’un message est envoyé.

HTTPErreurs et états

Les erreurs incluent code, message et détails de champs. 401 : authentification ; 403 : accès refusé ; 409 : conflit d’état, version, chemin, quota ou idempotence ; 422 : saisie invalide ; 503 : indisponibilité. Les codes suspendus ou bloqués renvoient 410.

MCPIntégration MCP

Connectez un client HTTP MCP avec la clé de votre espace. L’endpoint sans état fournit du JSON et cinq outils : lister, lire, créer, modifier et analyser. L’écriture requiert les droits adaptés. Les clients hébergés et leur connexion directe sont encore en vérification.

POST /api/mcp
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{ "jsonrpc": "2.0", "id": 1, "method": "tools/list", "params": {} }
Aide