Documentation API de QR codes dynamiques | QR Cake

Créez, mettez à jour et gérez des QR codes dynamiques avec l'API QR Cake. Utilisez des clés API, testez les requêtes et connectez vos workflows QR à vos propres outils.

API REST JSONCréation QR dynamiqueAuthentification par clé API

Démarrage rapide

L'API QR Cake permet aux utilisateurs de QR Cake de gérer les codes QR de leur compte.

URL de base

https://api.qrcake.com/v1/product/api

Points de terminaison

Lister les codes QRGET

/product

Récupérer un code QRGET

/product/{productId}

Créer un code QRPOST

/product

Mettre à jour un code QRPUT

/product/{productId}

Supprimer un code QRDELETE

/product/{productId}

AutorisationsGET

/permission

Authentification

Créez une clé API dans votre tableau de bord et envoyez-la dans l'en-tête x-api-key.

x-api-key: <API Key>
Content-Type: application/json

Gérez les clés API dans Clés API du tableau de bord.

Testeur de requêtes API

Testez les points de terminaison directement depuis cette page. Saisissez votre clé API, sélectionnez un point de terminaison et consultez la réponse en direct.

Testeur d'API interactif

Exécutez des requêtes directement depuis votre navigateur vers le point de terminaison API QR Cake sélectionné.

GET

Point de terminaison

Clé API

x-api-key: YOUR_API_KEY

URL résolue

https://api.qrcake.com/v1/product/api/product

Exécutez une requête pour voir ici l'état en direct et la réponse.

Terminologie

Produits

Codes QR

Utilisateurs

Comptes QR Cake

Corps de requête (POST/PUT)

Pour les requêtes POST et PUT, les corps de requête doivent être sérialisés sous forme de chaîne. Si vous envoyez du JSON, transmettez une chaîne JSON (par exemple JSON.stringify(payload)).

const payload = { redirect: "https://example.com", metadata: {} };

await fetch(url, {
  method: "POST",
  body: JSON.stringify(payload),
});

GET

Lister les codes QR

Liste les codes QR accessibles avec la clé API.

Ouvrir dans GitBook

Chemin: /product

URL: https://api.qrcake.com/v1/product/api/product

Détails de la requête

En-têtes

x-api-key: <API Key>
Accept: application/json

Réponses

200 OK

[
  {
    "accountId": "string",
    "productId": "string",
    "userId": "string",
    "redirect": "string",
    "state": "ACTIVE",
    "metadata": {},
    "createdAt": 0,
    "updatedAt": 0
  }
]

401 Unauthorized

{
  "message": {}
}

Produits = codes QR.

GET

Récupérer un code QR

Récupère un code QR.

Ouvrir dans GitBook

Chemin: /product/{productId}

URL: https://api.qrcake.com/v1/product/api/product/{productId}

Détails de la requête

Paramètres du chemin

productId (string)

En-têtes

x-api-key: <API Key>
Accept: application/json

Réponses

200 OK

{
  "accountId": "string",
  "productId": "string",
  "userId": "string",
  "redirect": "string",
  "state": "ACTIVE",
  "metadata": {},
  "createdAt": 0,
  "updatedAt": 0
}

401 Unauthorized

{
  "message": {}
}

POST

Créer un code QR

Crée un nouveau code QR.

Ouvrir dans GitBook

Chemin: /product

URL: https://api.qrcake.com/v1/product/api/product

Détails de la requête

En-têtes

x-api-key: <API Key>
Content-Type: application/json
Accept: application/json

Modèle de corps

{
  "redirect": "https://example.com",
  "metadata": {},
  "state": "ACTIVE"
}

Réponses

200 OK

{
  "accountId": "string",
  "productId": "string",
  "userId": "string",
  "redirect": "string",
  "state": "ACTIVE",
  "metadata": {},
  "createdAt": 0,
  "updatedAt": 0
}

401 Unauthorized

{
  "message": {}
}

Le corps de la requête POST doit être sérialisé sous forme de chaîne (par exemple, JSON.stringify(payload)).

PUT

Mettre à jour un code QR

Met à jour un code QR existant.

Ouvrir dans GitBook

Chemin: /product/{productId}

URL: https://api.qrcake.com/v1/product/api/product/{productId}

Détails de la requête

Paramètres du chemin

productId (string)

En-têtes

x-api-key: <API Key>
Content-Type: application/json
Accept: application/json

Modèle de corps

{
  "redirect": "https://example.com",
  "metadata": {},
  "state": "ACTIVE"
}

Réponses

200 OK

{
  "accountId": "string",
  "productId": "string",
  "userId": "string",
  "redirect": "string",
  "state": "ACTIVE",
  "metadata": {},
  "expiresAt": 0,
  "createdAt": 0,
  "updatedAt": 0
}

401 Unauthorized

{
  "message": {}
}

Le corps de la requête PUT doit être sérialisé sous forme de chaîne.

DELETE

Supprimer un code QR

Supprime un code QR.

Ouvrir dans GitBook

Chemin: /product/{productId}

URL: https://api.qrcake.com/v1/product/api/product/{productId}

Détails de la requête

Paramètres du chemin

productId (string)

En-têtes

x-api-key: <API Key>
Accept: application/json

Réponses

200 OK

{
  "productId": "string"
}

401 Unauthorized

{
  "message": {}
}

GET

Autorisations

Renvoie les autorisations accordées à la clé API.

Ouvrir dans GitBook

Chemin: /permission

URL: https://api.qrcake.com/v1/product/api/permission

Détails de la requête

En-têtes

x-api-key: <API Key>
Accept: application/json

Réponses

200 OK

{
  "success": true,
  "result": {
    "tier": "subscriber",
    "active": true,
    "analytics": true,
    "productLimit": 100,
    "productTotal": 3,
    "productActiveLimit": 100,
    "productActiveTotal": 3
  }
}

401 Unauthorized

{
  "message": {}
}

Types de QR pris en charge

Utilisez ces types de métadonnées lors de la création ou de la mise à jour de produits QR.

redirect, link, image, video, file, pdf, audio, app, event, vCard, review

Commencez par les codes QR dynamiques et les codes QR modifiables sur notre page d'accueil.