القوالب

curl "https://getqr.com/api/v1/templates?page=1&pageSize=100" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "data": [
    {
      "id": "qrt_8Hs2mQvKpLd4RtYw",
      "name": "Brand blue",
      "designKind": "custom",
      "design": {
        "styles": {
          "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
          "backgroundOptions": { "color": "#FFFFFF" }
        },
        "frameOptions": null,
        "logoOptions": null
      },
      "createdAt": "2026-07-20T09:12:00.000Z",
      "updatedAt": "2026-07-20T09:12:00.000Z"
    }
  ],
  "pagination": { "page": 1, "pageSize": 100, "total": 1, "hasMore": false }
}

curl "https://getqr.com/api/v1/templates?page=1&pageSize=100" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "data": [
    {
      "id": "qrt_8Hs2mQvKpLd4RtYw",
      "name": "Brand blue",
      "designKind": "custom",
      "design": {
        "styles": {
          "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
          "backgroundOptions": { "color": "#FFFFFF" }
        },
        "frameOptions": null,
        "logoOptions": null
      },
      "createdAt": "2026-07-20T09:12:00.000Z",
      "updatedAt": "2026-07-20T09:12:00.000Z"
    }
  ],
  "pagination": { "page": 1, "pageSize": 100, "total": 1, "hasMore": false }
}

GetQR API في مرحلة تجريبية (beta) ومتاحة لمساحات عمل مختارة. قد تتغير التفاصيل قبل الإصدار العام.

يحفظ القالب تصميمًا قابلًا لإعادة الاستخدام: styles وframeOptions وlogoOptions. لا يحمل أبدًا محتوى أو رابطًا. القوالب مشتركة بين جميع أعضاء مساحة العمل.

الطريقة	المسار	الوصف
`GET`	`/api/v1/templates`	عرض قائمة القوالب
`POST`	`/api/v1/templates`	إنشاء قالب
`GET`	`/api/v1/templates/{templateId}`	الحصول على قالب
`PATCH`	`/api/v1/templates/{templateId}`	تحديث قالب
`DELETE`	`/api/v1/templates/{templateId}`	حذف قالب
`POST`	`/api/v1/templates/{templateId}/duplicate`	تكرار قالب

تطبيق قالب

مرّر templateId عند إنشاء رمز QR. يُطبَّق تصميم القالب على رمز QR الجديد. ويُدمج فوقه أي من كائنات التصميم الثلاثة التي ترسلها في الطلب نفسه.

نسخ لا ربط. يحتفظ رمز QR بنسخته الخاصة من التصميم. تعديل القالب أو حذفه لاحقًا لا يغيّره.
التصاميم المخصصة فقط. لا يمكن تطبيق قالب قيمة designKind فيه branded أو ai عبر API، ويُرجع 422 (art_template_unsupported).
مساحة عملك فقط. يُرجع القالب غير المعروف، أو القالب من مساحة عمل أخرى، 404.

الترويسات

string

مطلوب

Bearer متبوعة بمفتاح API الخاص بك. راجع المصادقة.

string

application/json. مطلوب في الطلبات التي تحتوي على جسم.

كائن القالب

string

معرّف القالب، مثل qrt_8Hs2mQvKpLd4RtYw.

string

الاسم المعروض عند اختيار قالب.

string

للقراءة فقط. custom تصميم يمكن لـ API تعديله بالكامل. branded وai تصميم بعلامة تجارية أو تصميم بالذكاء الاصطناعي أُنشئ في لوحة التحكم: لا يمكن تعديل صورته عبر API، ويُحتفظ به عند تغيير حقول التصميم الأخرى.

object

التصميم المحفوظ. لكل حقل البنية نفسها لحقل الطلب الذي يحمل الاسم نفسه، فيمكنك إرساله مرة أخرى.

إظهار properties

object | null

أشكال النقاط والزوايا وألوانها.

object | null

الإطار حول رمز QR ونص الدعوة إلى الإجراء.

object | null

الشعار في الوسط.

string

تاريخ الإنشاء، بصيغة ISO 8601.

string

تاريخ آخر تحديث، بصيغة ISO 8601.

عرض قائمة القوالب

GET /api/v1/templates يُرجع قوالب مساحة عملك، الأحدث أولًا. القائمة مقسّمة إلى صفحات: راجع ترقيم الصفحات.

integer

افتراضي:"1"

الصفحة التي تُعاد، 1 أو أكبر.

integer

افتراضي:"100"

النتائج في كل صفحة، من 1 إلى 100.

curl "https://getqr.com/api/v1/templates?page=1&pageSize=100" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "data": [
    {
      "id": "qrt_8Hs2mQvKpLd4RtYw",
      "name": "Brand blue",
      "designKind": "custom",
      "design": {
        "styles": {
          "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
          "backgroundOptions": { "color": "#FFFFFF" }
        },
        "frameOptions": null,
        "logoOptions": null
      },
      "createdAt": "2026-07-20T09:12:00.000Z",
      "updatedAt": "2026-07-20T09:12:00.000Z"
    }
  ],
  "pagination": { "page": 1, "pageSize": 100, "total": 1, "hasMore": false }
}

إنشاء قالب

POST /api/v1/templates يحفظ تصميمًا جديدًا. يُرجع 201 Created. يُتحقق من حقول التصميم وفق الكتالوجات في التخصيص، لذا يُرفض الشكل أو الإطار أو الشعار غير المعروف بالخطأ 422.

string

مطلوب

الاسم المعروض عند اختيار قالب، من 1 إلى 40 حرفًا.

object

أشكال النقاط والزوايا وألوانها. راجع التخصيص.

object

الإطار المرسوم حول رمز QR ونص الدعوة إلى الإجراء. راجع التخصيص.

object

الشعار الموضوع في الوسط: شعار مقترح، أو ملفك الخاص المرفوع بالغرض logo عبر الملفات. راجع التخصيص.

curl -X POST "https://getqr.com/api/v1/templates" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Brand blue",
    "styles": {
      "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
      "backgroundOptions": { "color": "#FFFFFF" }
    }
  }'

{
  "id": "qrt_8Hs2mQvKpLd4RtYw",
  "name": "Brand blue",
  "designKind": "custom",
  "design": {
    "styles": {
      "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
      "backgroundOptions": { "color": "#FFFFFF" }
    },
    "frameOptions": null,
    "logoOptions": null
  },
  "createdAt": "2026-07-20T09:12:00.000Z",
  "updatedAt": "2026-07-20T09:12:00.000Z"
}

الحصول على قالب

GET /api/v1/templates/{templateId}

string

مطلوب

معرّف القالب. خذه من استجابة القائمة أو الإنشاء.

curl "https://getqr.com/api/v1/templates/qrt_8Hs2mQvKpLd4RtYw" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "id": "qrt_8Hs2mQvKpLd4RtYw",
  "name": "Brand blue",
  "designKind": "custom",
  "design": {
    "styles": {
      "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
      "backgroundOptions": { "color": "#FFFFFF" }
    },
    "frameOptions": null,
    "logoOptions": null
  },
  "createdAt": "2026-07-20T09:12:00.000Z",
  "updatedAt": "2026-07-20T09:12:00.000Z"
}

تحديث قالب

PATCH /api/v1/templates/{templateId} أرسل فقط الحقول التي تريد تغييرها. تُدمج كائنات التصميم في التصميم المحفوظ، لذا يحتفظ styles الجزئي ببقية القيم. تحتفظ رموز QR المُنشأة سابقًا من القالب بالتصميم الذي أُنشئت به.

string

مطلوب

معرّف القالب.

string

الاسم الجديد، من 1 إلى 40 حرفًا.

object

تغييرات الأنماط، تُدمج في styles المحفوظ.

object

تغييرات الإطار، تُدمج في الإطار المحفوظ.

object

تغييرات الشعار، تُدمج في الشعار المحفوظ.

curl -X PATCH "https://getqr.com/api/v1/templates/qrt_8Hs2mQvKpLd4RtYw" \
  -H "Authorization: Bearer $GETQR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Brand blue (2026)" }'

{
  "id": "qrt_8Hs2mQvKpLd4RtYw",
  "name": "Brand blue (2026)",
  "designKind": "custom",
  "design": {
    "styles": {
      "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
      "backgroundOptions": { "color": "#FFFFFF" }
    },
    "frameOptions": null,
    "logoOptions": null
  },
  "createdAt": "2026-07-20T09:12:00.000Z",
  "updatedAt": "2026-08-14T09:00:00.000Z"
}

حذف قالب

DELETE /api/v1/templates/{templateId} يحذف القالب. تحتفظ رموز QR المُنشأة منه بتصميمها.

string

مطلوب

معرّف القالب.

curl -X DELETE "https://getqr.com/api/v1/templates/qrt_8Hs2mQvKpLd4RtYw" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{ "id": "qrt_8Hs2mQvKpLd4RtYw", "deleted": true }

تكرار قالب

POST /api/v1/templates/{templateId}/duplicate يُنشئ نسخة باسم <name> copy، لها معرّفها الخاص وتصميم مستقل يمكنك تعديله بحرية. لا يأخذ جسم طلب. يُرجع 201 Created.

string

مطلوب

معرّف القالب المراد نسخه.

curl -X POST "https://getqr.com/api/v1/templates/qrt_8Hs2mQvKpLd4RtYw/duplicate" \
  -H "Authorization: Bearer $GETQR_API_KEY"

{
  "id": "qrt_2Kd9pLm4Xs7BnVcQ",
  "name": "Brand blue copy",
  "designKind": "custom",
  "design": {
    "styles": {
      "dotsOptions": { "type": "rounded", "color": "#1E40AF" },
      "backgroundOptions": { "color": "#FFFFFF" }
    },
    "frameOptions": null,
    "logoOptions": null
  },
  "createdAt": "2026-08-14T09:30:00.000Z",
  "updatedAt": "2026-08-14T09:30:00.000Z"
}

المشكلات الشائعة

404 "QR template not found."

لا يطابق templateId أي قالب في مساحة عملك. خذه من عرض قائمة القوالب.

الخطأ 422 عند إنشاء قالب أو تحديثه

أحد حقول التصميم لا يطابق الكتالوجات، مثل نوع نقاط أو إطار أو شعار مقترح غير معروف. تذكر الرسالة اسم الحقل. راجع التخصيص.

الخطأ 422 art_template_unsupported عند إنشاء رمز QR

يستخدم القالب تصميمًا بعلامة تجارية أو تصميمًا بالذكاء الاصطناعي. طبّق بدلًا منه قالبًا قيمة designKind فيه custom.

API

تطبيق قالب

الترويسات

كائن القالب

عرض قائمة القوالب

إنشاء قالب

الحصول على قالب

تحديث قالب

حذف قالب

تكرار قالب

المشكلات الشائعة

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

التخصيص

رموز QR

القوالب في التطبيق

الملفات

​تطبيق قالب

​الترويسات

​كائن القالب

​عرض قائمة القوالب

​إنشاء قالب

​الحصول على قالب

​تحديث قالب

​حذف قالب

​تكرار قالب

​المشكلات الشائعة

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

التخصيص

رموز QR

القوالب في التطبيق

الملفات

تطبيق قالب

الترويسات

كائن القالب

عرض قائمة القوالب

إنشاء قالب

الحصول على قالب

تحديث قالب

حذف قالب

تكرار قالب

المشكلات الشائعة

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