API-documentatie

Ontwikkelaarsbronnen en handleidingen voor de integratie QR Cake .

JSON-REST APIDynamische QR-creatieBearer Autorisatie

Maak API sleutel

Snel beginnen

Met QR Cake API kunnen QR Cake gebruikers hun account QR Codes beheren.

Basis URL

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

Eindpunten

Lijst QR CodesGET

/user/product

Ontvang een QR-codeGET

/product/{productId}

Maak een QR-codePOST

/product

Update een QR-codePUT

/product/{productId}

Verwijder een QR-codeDELETE

/product/{productId}

MachtigingenGET

/permission

Authenticatie

Maak een API-sleutel in uw dashboard en verzend deze in de Autorisatie-header.

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

Beheer API sleutels in Dashboard API Sleutels.

API Tester aanvragen

Test eindpunten rechtstreeks vanaf deze pagina. Voer uw API sleutel in, selecteer een eindpunt en inspecteer het live antwoord.

Interactieve API Tester

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

GET

Eindpunt

API Sleutel

Authorization: Bearer <API Key>

Opgelost URL

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

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

Terminologie

Producten

QR Codes

Gebruikers

QR Cake accounts

Verzoekinstanties (POST/PUT)

Voor POST- en PUT-verzoeken moeten de verzoekteksten worden gestringificeerd. Als u JSON verzendt, geeft u een JSON-tekenreeks door (bijvoorbeeld JSON.stringify(payload)).

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

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

GET

Lijst QR Codes

Geeft de QR Codes weer die toegankelijk is voor de API sleutel.

Openen in GitBook

Pad: /user/product

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

Details aanvragen

Kopteksten

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

Reacties

200 OK

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

401 Unauthorized

{
  "message": {}
}

Producten = QR Codes.

GET

Ontvang een QR-code

Haalt één QR-code op.

Openen in GitBook

Pad: /product/{productId}

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

Details aanvragen

Padparameters

productId (string)

Kopteksten

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

Reacties

200 OK

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

401 Unauthorized

{
  "message": {}
}

POST

Maak een QR-code

Creëert een nieuw QR-codeproduct.

Openen in GitBook

Pad: /product

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

Details aanvragen

Kopteksten

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

Lichaamssjabloon

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

Reacties

200 OK

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

401 Unauthorized

{
  "message": {}
}

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

PUT

Update een QR-code

Werkt een bestaande QR-code (product) bij.

Openen in GitBook

Pad: /product/{productId}

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

Details aanvragen

Padparameters

productId (string)

Kopteksten

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

Lichaamssjabloon

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

Reacties

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

Verwijder een QR-code

Verwijdert een QR-code.

Openen in GitBook

Pad: /product/{productId}

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

Details aanvragen

Padparameters

productId (string)

Kopteksten

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

Reacties

200 OK

{
  "productId": "string"
}

401 Unauthorized

{
  "message": {}
}

GET

Machtigingen

Retourneert de machtigingen die zijn verleend aan de sleutel API.

Openen in GitBook

Pad: /permission

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

Details aanvragen

Kopteksten

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

Reacties

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.