وثائق واجهة برمجة التطبيقات
رموز QR

واجهة برمجة تطبيقات رموز QR

إنشاء وتحديث وإدارة رموز QR الديناميكية برمجيًا. يمكن تخصيص كل رمز QR بالألوان والشعارات وإمكانيات التتبع.

نقاط النهاية

طريقةنقطة النهايةوصف
POST
/organizations/:orgId/qr-codesإنشاء رمز QR جديد
GET
/organizations/:orgId/qr-codesقائمة بجميع رموز QR
GET
/organizations/:orgId/qr-codes/:idاحصل على رمز QR محدد
PUT
/organizations/:orgId/qr-codes/:idتحديث رمز QR
DELETE
/organizations/:orgId/qr-codes/:idاحذف رمز QR
GET
/organizations/:orgId/qr-codes/:id/downloadتحميل صورة رمز الاستجابة السريعة

إنشاء رمز QR

أنشئ رمز QR ديناميكي جديد بمحتوى وتصميم قابلين للتخصيص.

POST
/organizations/:orgId/qr-codes

جسم الطلب

معاملاكتبمطلوبوصف
typestring
مطلوب
نوع رمز الاستجابة السريعة (URL، VCARD، WIFI، إلخ)
namestring
مطلوب
اسم العرض لرمز الاستجابة السريعة
dataobject
مطلوب
بيانات المحتوى (تختلف حسب النوع)
styleobject
اختياري
خيارات التخصيص المرئي
folderIdstring
اختياري
مجلد لتنظيم رمز الاستجابة السريعة
tagsstring[]
اختياري
علامات للتصنيف

أمثلة حسب النوع

رمز QR للعنوان الإلكتروني
curl -X POST \
  https://api.iloveqr.com/api/v1/organizations/org_abc123/qr-codes \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "URL",
    "name": "Company Website",
    "data": {
      "url": "https://example.com"
    },
    "style": {
      "foregroundColor": "#000000",
      "backgroundColor": "#FFFFFF",
      "cornerRadius": 10
    }
  }'

استجابة

{
  "id": "qr_xyz789",
  "type": "URL",
  "name": "Company Website",
  "shortUrl": "https://ilqr.co/xyz789",
  "shortCode": "xyz789",
  "data": {
    "url": "https://example.com"
  },
  "style": {
    "foregroundColor": "#000000",
    "backgroundColor": "#FFFFFF",
    "cornerRadius": 10
  },
  "status": "ACTIVE",
  "totalScans": 0,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

قائمة رموز QR

استرجاع قائمة صفحات من رموز QR مع تصفية اختيارية.

GET
/organizations/:orgId/qr-codes

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

معاملاكتبوصف
pagenumberرقم الصفحة (افتراضي: 1)
limitnumberالعناصر في الصفحة (افتراضي: 20، الحد الأقصى: 100)
typestringتصفية حسب نوع رمز الاستجابة السريعة
folderIdstringتصفية حسب المجلد
searchstringابحث بالاسم
statusstringتصفية حسب الحالة (نشط، مؤرشف)

تحديث رمز الاستجابة السريعة

تحديث محتوى رمز الاستجابة السريعة الحالي، أو تنسيقه، أو بياناته الوصفية. تظل صورة رمز الاستجابة السريعة كما هي بينما يتغير الوجهة.

PUT
/organizations/:orgId/qr-codes/:id
curl -X PUT \
  https://api.iloveqr.com/api/v1/organizations/org_abc123/qr-codes/qr_xyz789 \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Website",
    "data": {
      "url": "https://new-url.example.com"
    }
  }'

حذف رمز الاستجابة السريعة

احذف رمز QR بشكل دائم. لا يمكن التراجع عن هذا الإجراء. سيتوقف الرابط القصير عن العمل.

DELETE
/organizations/:orgId/qr-codes/:id
curl -X DELETE \
  https://api.iloveqr.com/api/v1/organizations/org_abc123/qr-codes/qr_xyz789 \
  -H "X-API-Key: YOUR_API_KEY"

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

URL

رابط إلى أي موقع ويب أو صفحة ويب

VCARD

شارك معلومات الاتصال

WIFI

الاتصال بشبكات الواي فاي

PDF

رابط إلى مستندات PDF

EMAIL

تكوين بريد إلكتروني مسبق التعبئة

SMS

رسالة SMS مسبقة التعبئة

PHONE

مكالمة هاتفية مباشرة

TEXT

نص عادي

MENU

قائمة مطعم رقمية

APP

روابط متجر التطبيقات

VIDEO

روابط محتوى الفيديو

SOCIAL

روابط وسائل التواصل الاجتماعي

الخطوات التالية

تعرف على الميزات ذات الصلة: