Dokumentacja API

Szybki start

Interfejs API QR Cake pozwala użytkownikom QR Cake zarządzać kodami QR na koncie.

Uwierzytelnianie

Utwórz klucz API w panelu i przesyłaj go w nagłówku Authorization.

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

Zarządzaj kluczami API w sekcji Klucze API.

Tester żądań API

Testuj endpointy bezpośrednio z tej strony. Wprowadź klucz API, wybierz endpoint i sprawdź odpowiedź na żywo.

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

Terminologia

Treść żądań (POST/PUT)

W przypadku żądań POST i PUT treść musi być zserializowana do ciągu znaków. Jeśli wysyłasz JSON, przekaż go jako ciąg znaków (na przykład 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": {}
}

Produkty = kody QR.

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

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

{
  "message": {}
}

Treść żądania POST musi być zserializowana do ciągu znaków (na przykład 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": {}
}

Treść żądania PUT musi być zserializowana do ciągu znaków.

Obsługiwane typy QR

Używaj tych typów metadanych podczas tworzenia lub aktualizowania produktów QR.

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

Zacznij od dynamicznych kodów QR i edytowalnych kodów QR na naszej stronie głównej.