API-documentatie

Ontwikkelaarsbronnen en handleidingen voor integratie met QR Cake.

JSON REST APIDynamische QR-creatieBearer-autorisatie

Snel beginnen

Met de QR Cake API kunnen QR Cake-gebruikers de QR-codes in hun account beheren.

Basis-URL

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

Eindpunten

QR-codes weergevenGET

/user/product

Eén QR-code ophalenGET

/product/{productId}

Een QR-code aanmakenPOST

/product

Een QR-code bijwerkenPUT

/product/{productId}

Een QR-code verwijderenDELETE

/product/{productId}

MachtigingenGET

/permission

Authenticatie

Maak een API-sleutel aan in je dashboard en stuur deze mee in de Authorization-header.

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

Beheer API-sleutels in Dashboard API-sleutels.

API-verzoektester

Test eindpunten rechtstreeks vanaf deze pagina. Voer je API-sleutel in, selecteer een eindpunt en bekijk het live antwoord.

Interactieve API-tester

Voer verzoeken rechtstreeks vanuit je browser uit naar het geselecteerde QR Cake API-eindpunt.

GET

Eindpunt

API-sleutel

Authorization: Bearer YOUR_API_KEY

Volledige URL

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

Voer hier een verzoek uit om de livestatus en het antwoord te bekijken.

Terminologie

Producten

QR-codes

Gebruikers

QR Cake-accounts

Verzoektekst (POST/PUT)

Voor POST- en PUT-verzoeken moeten de verzoekteksten als string worden meegegeven. Als je JSON verzendt, geef je een JSON-string door (bijvoorbeeld JSON.stringify(payload)).

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

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

GET

QR-codes weergeven

Geeft de QR-codes weer die toegankelijk zijn voor de API-sleutel.

Openen in GitBook

Pad: /user/product

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

Verzoekgegevens

Headers

Authorization: Bearer <API Key>
Accept: application/json

Antwoorden

200 OK

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

401 Unauthorized

{
  "message": {}
}

Producten = QR-codes.

GET

Eén QR-code ophalen

Haalt één QR-code op.

Openen in GitBook

Pad: /product/{productId}

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

Verzoekgegevens

Padparameters

productId (string)

Headers

Authorization: Bearer <API Key>
Accept: application/json

Antwoorden

200 OK

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

401 Unauthorized

{
  "message": {}
}

POST

Een QR-code aanmaken

Maakt een nieuw QR-codeproduct aan.

Openen in GitBook

Pad: /product

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

Verzoekgegevens

Headers

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

Sjabloon voor verzoektekst

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

Antwoorden

200 OK

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

401 Unauthorized

{
  "message": {}
}

De hoofdtekst van het POST-verzoek moet een string zijn (bijvoorbeeld JSON.stringify(payload)).

PUT

Een QR-code bijwerken

Werkt een bestaande QR-code (product) bij.

Openen in GitBook

Pad: /product/{productId}

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

Verzoekgegevens

Padparameters

productId (string)

Headers

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

Sjabloon voor verzoektekst

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

Antwoorden

200 OK

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

401 Unauthorized

{
  "message": {}
}

De hoofdtekst van het verzoek moet een string zijn.

DELETE

Een QR-code verwijderen

Verwijdert een QR-code.

Openen in GitBook

Pad: /product/{productId}

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

Verzoekgegevens

Padparameters

productId (string)

Headers

Authorization: Bearer <API Key>
Accept: application/json

Antwoorden

200 OK

{
  "productId": "string"
}

401 Unauthorized

{
  "message": {}
}

GET

Machtigingen

Geeft de machtigingen terug die aan de API-sleutel zijn verleend.

Openen in GitBook

Pad: /permission

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

Verzoekgegevens

Headers

Authorization: Bearer <API Key>
Accept: application/json

Antwoorden

200 OK

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

401 Unauthorized

{
  "message": {}
}

Ondersteunde QR-typen

Gebruik deze typen metagegevens bij het maken of bijwerken van QR-producten.

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

Begin met dynamische QR-codes en veranderlijke QR-codes op onze homepage.