توثيق API لرموز QR الديناميكية | QR Cake

أنشئ رموز QR الديناميكية وحدّثها وأدرها عبر واجهة QR Cake البرمجية. استخدم مفاتيح API واختبر الطلبات واربط سير عمل رموز QR بأدواتك الخاصة.

واجهة REST بصيغة JSONإنشاء رموز QR ديناميكيةمصادقة بمفتاح API

بداية سريعة

تتيح واجهة QR Cake البرمجية لمستخدمي QR Cake إدارة رموز QR الموجودة في حساباتهم.

الرابط الأساسي

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

نقاط النهاية

/product

/product/{productId}

/product

/product/{productId}

/product/{productId}

/permission

المصادقة

أنشئ مفتاح API من لوحة التحكم وأرسله في ترويسة x-api-key.

x-api-key: <API Key>
Content-Type: application/json

أدر مفاتيح API من مفاتيح API في لوحة التحكم.

أداة اختبار طلبات API

اختبر نقاط النهاية مباشرة من هذه الصفحة. أدخل مفتاح API واختر نقطة نهاية ثم افحص الاستجابة الحية.

أداة اختبار API تفاعلية

شغّل الطلبات مباشرة من متصفحك إلى نقطة نهاية API المحددة في QR Cake.

GET

نقطة النهاية

مفتاح API

x-api-key: YOUR_API_KEY

الرابط النهائي

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

شغّل طلبًا لتظهر هنا الحالة والاستجابة الحية.

المصطلحات

Products

رموز QR

Users

حسابات QR Cake

جسم الطلب (POST/PUT)

في طلبات POST وPUT يجب تحويل جسم الطلب إلى نص. وإذا كنت ترسل JSON فمرّره كسلسلة نصية (على سبيل المثال JSON.stringify(payload)).

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

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

GET

عرض قائمة رموز QR

يعرض رموز QR المتاحة لمفتاح API.

افتح في GitBook

المسار: /product

الرابط: https://api.qrcake.com/v1/product/api/product

تفاصيل الطلب

الترويسات

x-api-key: <API Key>
Accept: application/json

الاستجابات

200 OK

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

401 غير مصرّح

{
  "message": {}
}

Products = رموز QR.

GET

جلب رمز QR

يجلب رمز QR واحدًا.

افتح في GitBook

المسار: /product/{productId}

الرابط: https://api.qrcake.com/v1/product/api/product/{productId}

تفاصيل الطلب

معاملات المسار

productId (string)

الترويسات

x-api-key: <API Key>
Accept: application/json

الاستجابات

200 OK

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

401 غير مصرّح

{
  "message": {}
}

POST

إنشاء رمز QR

ينشئ منتج رمز QR جديدًا.

افتح في GitBook

المسار: /product

الرابط: https://api.qrcake.com/v1/product/api/product

تفاصيل الطلب

الترويسات

x-api-key: <API Key>
Content-Type: application/json
Accept: application/json

قالب جسم الطلب

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

الاستجابات

200 OK

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

401 غير مصرّح

{
  "message": {}
}

يجب تحويل جسم طلب POST إلى نص (على سبيل المثال JSON.stringify(payload)).

PUT

تحديث رمز QR

يحدّث رمز QR موجودًا (منتجًا).

افتح في GitBook

المسار: /product/{productId}

الرابط: https://api.qrcake.com/v1/product/api/product/{productId}

تفاصيل الطلب

معاملات المسار

productId (string)

الترويسات

x-api-key: <API Key>
Content-Type: application/json
Accept: application/json

قالب جسم الطلب

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

الاستجابات

200 OK

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

401 غير مصرّح

{
  "message": {}
}

يجب تحويل جسم طلب PUT إلى نص.

DELETE

حذف رمز QR

يحذف رمز QR.

افتح في GitBook

المسار: /product/{productId}

الرابط: https://api.qrcake.com/v1/product/api/product/{productId}

تفاصيل الطلب

معاملات المسار

productId (string)

الترويسات

x-api-key: <API Key>
Accept: application/json

الاستجابات

200 OK

{
  "productId": "string"
}

401 غير مصرّح

{
  "message": {}
}

GET

الأذونات

يعيد الأذونات الممنوحة لمفتاح API.

افتح في GitBook

المسار: /permission

الرابط: https://api.qrcake.com/v1/product/api/permission

تفاصيل الطلب

الترويسات

x-api-key: <API Key>
Accept: application/json

الاستجابات

200 OK

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

401 غير مصرّح

{
  "message": {}
}

أنواع رموز QR المدعومة

استخدم أنواع البيانات الوصفية هذه عند إنشاء رموز QR أو تحديثها.

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

ابدأ من رموز QR الديناميكية ورموز QR القابلة للتغيير على صفحتنا الرئيسية.