API-dokumentation

Udviklerressourcer og vejledninger til integration QR Cake .

JSON REST APIDynamisk QR-oprettelseBearer Godkendelse

Opret API nøgle

Hurtig start

QR Cake API lader QR Cake brugere administrere deres konto QR Codes.

Base URL

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

Slutpunkter

Liste QR CodesGET

/user/product

Få en QR-kodeGET

/product/{productId}

Opret en QR-kodePOST

/product

Opdater en QR-kodePUT

/product/{productId}

Slet en QR-kodeDELETE

/product/{productId}

TilladelserGET

/permission

Autentificering

Opret en API nøgle i dit dashboard, og send den i autorisationsoverskriften.

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

Administrer API nøgler ind Dashboard API Taster.

API Anmod om tester

Test slutpunkter direkte fra denne side. Indtast din API-nøgle, vælg et slutpunkt, og inspicér live-svaret.

Interaktiv API tester

Kør anmodninger direkte fra din browser til det valgte QR Cake API slutpunkt.

GET

Slutpunkt

API Nøgle

Authorization: Bearer <API Key>

Løst URL

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

Kør en anmodning for at se livestatus og svaroutput her.

Terminologi

Produkter

QR Codes

Brugere

QR Cake konti

Anmodningsorganer (POST/PUT)

For POST og PUT anmodninger skal anmodningsorganer være strengt. Hvis du sender JSON, skal du sende en JSON-streng (f.eks JSON.stringify(payload)).

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

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

GET

Liste QR Codes

Viser de QR Codes, der er tilgængelige for nøglen API.

Åbn i GitBook

Sti: /user/product

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

Anmod om detaljer

Overskrifter

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

Svar

200 OK

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

401 Unauthorized

{
  "message": {}
}

Produkter = QR Codes.

GET

Få en QR-kode

Henter én QR-kode.

Åbn i GitBook

Sti: /product/{productId}

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

Anmod om detaljer

Stiparameter

productId (string)

Overskrifter

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

Svar

200 OK

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

401 Unauthorized

{
  "message": {}
}

POST

Opret en QR-kode

Opretter et nyt QR-kodeprodukt.

Åbn i GitBook

Sti: /product

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

Anmod om detaljer

Overskrifter

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

Krop skabelon

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

Svar

200 OK

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

401 Unauthorized

{
  "message": {}
}

POST anmodningstekst skal være strengt (f.eks. JSON.stringify(payload)).

PUT

Opdater en QR-kode

Opdaterer en eksisterende QR-kode (produkt).

Åbn i GitBook

Sti: /product/{productId}

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

Anmod om detaljer

Stiparameter

productId (string)

Overskrifter

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

Krop skabelon

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

Svar

200 OK

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

401 Unauthorized

{
  "message": {}
}

PUT anmodningstekst skal strengificeres.

DELETE

Slet en QR-kode

Sletter en QR-kode.

Åbn i GitBook

Sti: /product/{productId}

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

Anmod om detaljer

Stiparameter

productId (string)

Overskrifter

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

Svar

200 OK

{
  "productId": "string"
}

401 Unauthorized

{
  "message": {}
}

GET

Tilladelser

Returnerer de tilladelser, der er givet til nøglen API.

Åbn i GitBook

Sti: /permission

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

Anmod om detaljer

Overskrifter

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

Svar

200 OK

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

401 Unauthorized

{
  "message": {}
}

Understøttede QR-typer

Brug disse metadatatyper, når du opretter eller opdaterer QR-produkter.

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

Start med dynamiske QR-koder og udskiftelige QR-koder på vores hjemmeside.