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

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

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

    بداية سريعة

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

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

    المصادقة

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

    يحمل كل مفتاح صلاحيات تُختار عند إنشائه (قراءة رموز QR، وإنشاء رموز QR وتحديثها، وقراءة تحليلات المسح)، ولا يظهر المفتاح كاملًا إلا مرة واحدة.

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

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

    دليل QR Code API: إنشاء الرموز وإدارتها برمجيًا (2026)

    خادم MCP لمساعدي الذكاء الاصطناعي

    يشغّل QR Cake أيضًا خادم MCP (Model Context Protocol) عن بُعد، فيستطيع Claude وClaude Code وCursor وVS Code عرض رموز QR وإنشاءها وتحديثها وحذفها أثناء المحادثة. يتم الاتصال بتسجيل الدخول إلى حسابك في QR Cake.

    رابط الخادم
    https://api.qrcake.com/mcp
    البيانات الوصفية للمورد (RFC 9728)
    https://api.qrcake.com/.well-known/oauth-protected-resource/mcp

    المصادقة

    يفتح العميل صفحة تسجيل الدخول إلى QR Cake عند أول اتصال. سجّل الدخول ثم وافق على ما يُسمح للعميل بفعله. لا يُدخَل أي مفتاح API أو كلمة مرور في العميل؛ مفاتيح API تعمل مع REST API فقط.

    تعتمد الأدوات التي يستطيع العميل استدعاءها على الصلاحيات التي توافق عليها. الأدوات الثلاث التي لا تحتاج إلى صلاحية متاحة دائمًا.

    codes.read

    قراءة رموز QR وحدود الباقة

    codes.write

    إنشاء رموز QR وتحديثها وحذفها

    analytics.read

    قراءة تحليلات المسح (باقتا Pro وBusiness)

    الأدوات

    الأداةالصلاحيةوظيفتها
    list_qr_codes
    codes.read
    تعرض كل رموز QR التي تملكها مع رابطها المختصر ووجهتها وحالتها.
    get_qr_code
    codes.read
    تجلب أحد رموز QR لديك بواسطة معرّفه.
    get_plan_limits
    codes.read
    مستوى باقتك، وعدد الرموز والرموز النشطة المستخدمة مقارنةً بحدودها، وهل التحليلات مشمولة، وحد النطاقات المخصصة.
    create_qr_code
    codes.write
    تنشئ رمز QR ديناميكيًا يعيد رابطه المختصر التوجيه إلى الرابط المحدد، مع تطبيق حدود باقتك.
    update_qr_code
    codes.write
    تغيّر وجهة رمز QR أو حالته أو بياناته الوصفية أو خياراته دون إعادة طباعته، وتحتفظ الحقول غير المذكورة بقيمها.
    create_file_upload
    codes.write
    يجهّز رفع ملف (صورة أو PDF أو صوت أو فيديو) لإرفاقه برمز QR. يرفع العميل الملف بنفسه.
    delete_qr_code
    codes.write
    تحذف رمز QR نهائيًا، فتتوقف نسخه المطبوعة عن العمل.
    design_qr_code
    codes.read
    codes.write
    تفتح محرر تصميم تفاعليًا لأحد رموز QR لديك، لتغيير أشكاله وألوانه وشعاره وإطاره ثم حفظ النتيجة.
    get_qr_code_analytics
    analytics.read
    تحليلات المسح لرمز QR واحد (التفاعلات أو المواقع أو الأجهزة أو الجغرافيا، خلال أسبوع أو شهر أو سنة). تتطلب باقة تشمل التحليلات.
    render_qr_codeلا شيءتحوّل أي نص أو رابط إلى صورة رمز QR أسود على أبيض (PNG) أو شيفرة SVG. لا يُحفظ أي شيء.
    build_qr_contentلا شيءتحوّل بيانات WiFi أو بطاقة اتصال أو بريدًا إلكترونيًا أو SMS أو مكالمة أو حدث تقويم أو موقعًا أو دفعة عملات مشفرة أو رابط WhatsApp أو خرائط أو FaceTime إلى النص الذي ينبغي أن يحمله رمز QR.
    analyze_qr_designلا شيءتقدّر مقدار ما يستهلكه التصميم المخصص (الألوان، نمط الوحدات، الشعار) من كل كتلة لتصحيح الأخطاء، وتصدر حكمًا: سليم أو هش أو حرج أو متجاوز للحد.

    ربط عميل

    يمكن الاتصال من Claude وClaude Code وCursor وVS Code. العملاء الآخرون غير مقبولين حاليًا.

    Claude

    أضف عنوان الخادم كموصل مخصص في Claude، ثم سجّل الدخول عندما يُطلب منك.

    Claude Code
    claude mcp add --transport http qrcake https://api.qrcake.com/mcp

    ثم شغّل الأمر /mcp في Claude Code وسجّل الدخول.

    Cursor (mcp.json)
    {
      "mcpServers": {
        "qrcake": {
          "url": "https://api.qrcake.com/mcp"
        }
      }
    }
    VS Code (mcp.json)
    {
      "servers": {
        "qrcake": {
          "type": "http",
          "url": "https://api.qrcake.com/mcp"
        }
      }
    }
    • تحليلات المسح جزء من باقتي Pro وBusiness، وفي الباقة المجانية تُرجع get_qr_code_analytics خطأ.
    • تُحتسب الرموز المنشأة عبر MCP من حدود باقتك تمامًا كالرموز المنشأة في لوحة التحكم.
    • تحتاج رموز الملفات وPDF والصور والفيديو والصوت إلى رفع ملف. العميل القادر على إرسال طلبات ويب، مثل Claude Code أو Cursor، يستطيع رفع الملف باستخدام create_file_upload؛ وإلا فأنشئ هذه الرموز من لوحة التحكم.
    • في العميل الذي يدعم MCP Apps، مثل Claude، تفتح design_qr_code محرر التصميم داخل المحادثة نفسها. أما العملاء الآخرون فيتلقون بيانات الرمز بصيغة JSON.
    • يستمر الاتصال حتى 30 يومًا، وبعدها يطلب منك العميل تسجيل الدخول من جديد.

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

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

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

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

    GET
    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, review, email

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