QR Platform
Die untenstehende Referenz wird live aus der OpenAPI-Spec von node-qr gerendert.
Sie spiegelt jederzeit den aktuellen Stand der Endpunkte, Schemas und Sicherheitsanforderungen.
{
"items": [
{
"id": 1,
"type": "static",
"kind": "url",
"status": "active",
"title": "string",
"version": 0,
"slug": "string",
"shortUrl": "http://example.com",
"targetUrl": "string",
"tags": [
"string"
],
"folderId": 1,
"campaignId": 1,
"scanCount": 0,
"lastScannedAt": "string",
"createdAt": "string",
"updatedAt": "string",
"archivedAt": "string"
}
],
"pagination": {
"page": 1,
"pageSize": 1,
"total": 0,
"totalPages": 0,
"hasNextPage": true,
"hasPrevPage": true
}
}In: header
Scope: qrs:write
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
{
"id": 1,
"type": "static",
"kind": "url",
"status": "active",
"title": "string",
"version": 0,
"slug": "string",
"shortUrl": "http://example.com",
"targetUrl": "string",
"tags": [
"string"
],
"folderId": 1,
"campaignId": 1,
"scanCount": 0,
"lastScannedAt": "string",
"createdAt": "string",
"updatedAt": "string",
"archivedAt": "string",
"payload": {
"kind": "url",
"url": "http://example.com"
}
}{
"id": 1,
"type": "static",
"kind": "url",
"status": "active",
"title": "string",
"version": 0,
"slug": "string",
"shortUrl": "http://example.com",
"targetUrl": "string",
"tags": [
"string"
],
"folderId": 1,
"campaignId": 1,
"scanCount": 0,
"lastScannedAt": "string",
"createdAt": "string",
"updatedAt": "string",
"archivedAt": "string",
"payload": {
"kind": "url",
"url": "http://example.com"
}
}In: header
Scope: qrs:write
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
{
"id": 1,
"type": "static",
"kind": "url",
"status": "active",
"title": "string",
"version": 0,
"slug": "string",
"shortUrl": "http://example.com",
"targetUrl": "string",
"tags": [
"string"
],
"folderId": 1,
"campaignId": 1,
"scanCount": 0,
"lastScannedAt": "string",
"createdAt": "string",
"updatedAt": "string",
"archivedAt": "string",
"payload": {
"kind": "url",
"url": "http://example.com"
}
}{
"id": 1,
"type": "static",
"kind": "url",
"status": "active",
"title": "string",
"version": 0,
"slug": "string",
"shortUrl": "http://example.com",
"targetUrl": "string",
"tags": [
"string"
],
"folderId": 1,
"campaignId": 1,
"scanCount": 0,
"lastScannedAt": "string",
"createdAt": "string",
"updatedAt": "string",
"archivedAt": "string",
"payload": {
"kind": "url",
"url": "http://example.com"
}
}1 <= value1 <= value <= 200"createdAt" | "updatedAt" | "title" | "scanCount" | "lastScannedAt""asc" | "desc"1 <= length <= 200"static" | "dynamic""active" | "paused" | "archived" | "blocked""url" | "text" | "vcard" | "wifi" | "email" | "sms" | "phone" | "geo" | "event" | "pdf" | "landing"0 < value0 < value0 < valuecurl -X GET "https://example.com/v1/qr-codes"curl -X POST "https://example.com/v1/qr-codes" \ -H "Content-Type: application/json" \ -d '{ "type": "static", "kind": "url", "title": "string", "payload": { "kind": "url", "url": "http://example.com" } }'curl -X GET "https://example.com/v1/qr-codes/1"curl -X PATCH "https://example.com/v1/qr-codes/1" \ -H "Content-Type: application/json" \ -d '{}'curl -X DELETE "https://example.com/v1/qr-codes/1""static" | "dynamic""url" | "text" | "vcard" | "wifi" | "email" | "sms" | "phone" | "geo" | "event" | "pdf" | "landing"1 <= length <= 200urilength <= 20003 <= length <= 321 <= length <= 200urilength <= 2000"active" | "paused" | "archived"