توثيق API

أنشئ رموز QR وباركود من منتجك عبر REST API. أرسل JSON إلى /api/v1، واحصل على رسوم SVG مستضافة، ثم اعرض أو حدّث نفس الموارد.

إنشاء رمز QR

أرسل POST إلى /api/v1/qr-codes مع type ومحتوى وتصميم اختياري: ألوان، نمط الوحدات، شعار، عيون، وإطار. تتضمن الاستجابة عنوان URL لملف SVG مستضاف.

{
  "name": "Website QR",
  "type": "url",
  "url": "https://forqrcode.com",
  "style": "rounded",
  "size": 500,
  "ecc": "M",
  "foreground_color": "#17191c",
  "background_color": "#ffffff",
  "qr_code_logo": "https://forqrcode.com/logo.png",
  "qr_code_logo_size": 25
}
مرجع إنشاء QR

إنشاء باركود

أرسل POST إلى /api/v1/barcodes مع رمزية وvalue وألوان أو حجم اختياري. تتوفر أربعة وثلاثون نوعًا، من Code 128 إلى EAN-13.

{
  "name": "Product SKU",
  "type": "C128",
  "value": "FORQR-1001",
  "foreground_color": "#17191c",
  "background_color": "#ffffff",
  "width_scale": 2,
  "height": 80,
  "display_text": true
}
مرجع إنشاء الباركود

المصادقة

أرسل مفتاح API كرمز Bearer في كل طلب. يمكنك عرضه أو إعادة إنشائه من لوحة التحكم → الحساب → API.

Authorization: Bearer YOUR_API_KEY

عنوان URL الأساسي: https://forqrcode.com/api/v1

حدود المعدل

60 طلبًا في الدقيقة لكل مفتاح. تتضمن الاستجابات رؤوس X-RateLimit-*.

الأخطاء

تنسيق JSON:API للأخطاء:

{ "errors": [{ "title": "…", "status": "422" }] }

قد تتضمن أخطاء التحقق حقل source.pointer.

رموز QR

أنشئ رموز QR بشعار وألوان وأنماط وأنواع محتوى، ثم اعرضها أو حدّثها.

5 نقاط نهاية

الباركود

أنشئ باركود عبر 34 رمزية، مع خيارات اللون والحجم والتسمية.

5 نقاط نهاية

المستخدم

قراءة وتحديث ملف الحساب المصادق عليه.

نقطتا نهاية

رموز QR بالذكاء الاصطناعي

إنشاء رموز QR مُنسّقة بالذكاء الاصطناعي عبر Replicate.

5 نقاط نهاية

الروابط

روابط قصيرة لوجهات QR الديناميكية.

5 نقاط نهاية

الإحصائيات

تحليلات مسح الروابط مجمّعة حسب البُعد.

نقطتا نهاية

المشاريع

تنظيم رموز QR والباركود والروابط في مشاريع.

5 نقاط نهاية

النطاقات

نطاقات مخصصة للروابط القصيرة.

6 نقاط نهاية

البكسلات

بكسلات تتبع للروابط القصيرة.

5 نقاط نهاية

المدفوعات

سجل الفوترة للقراءة فقط.

نقطتا نهاية

السجلات

سجلات نشاط الحساب (تسجيل الدخول، إعادة إنشاء المفتاح، إلخ).

نقطة نهاية واحدة

الفرق

مساحات عمل الفريق المملوكة للمستخدم المصادق عليه.

5 نقاط نهاية

أعضاء الفريق

دعوة وإدارة الأعضاء في الفرق التي تملكها.

5 نقاط نهاية

عضوية الفرق

عرض والرد على دعوات الفريق الموجهة إليك.

4 نقاط نهاية