Documentation API

Démarrage rapide

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

Authentification

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

Authorization: Bearer <API Key>
Content-Type: application/json

Gérer 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.

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

Terminologie

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),
});

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

{
  "message": {}
}

Produits = codes QR.

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

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

{
  "message": {}
}

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

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

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

{
  "message": {}
}

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

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

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