واجهة REST

توثيق الواجهة

واجهة برمجية للوصول إلى الرموز وتحليلات المسح ومعلومات المساحة. صادق بمفتاح API من صفحة مفاتيح API. مواصفات OpenAPI 3.1 جاهزة للقراءة الآلية على /openapi.json.

المصادقة

تتطلب كل الطلبات Bearer token في ترويسة Authorization. أنشئ المفاتيح من صفحة مفاتيح API؛ يُعرض المفتاح الخام مرة واحدة عند الإنشاء، ثم تظهر البادئة فقط. المفاتيح مرتبطة بمساحة واحدة.

Authorization: Bearer qrf_live_...

حدود المعدل

حدود بالدقيقة لكل مساحة عمل (مشتركة بين جميع مفاتيح مساحة العمل). تحمل كل استجابة الترويسات أدناه؛ وتجاوز الحد يُعيد رمز الحالة 429 مع ترويسة Retry-After (عدد الثواني حتى تُعاد تهيئة النافذة).

  • Free — 60 req/min
  • Pro — 300 req/min
  • Business — 1,000 req/min
X-RateLimit-Plan: pro
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 297
X-RateLimit-Reset: 1718724000

# When exceeded:
HTTP/1.1 429 Too Many Requests
Retry-After: 42

المسارات

GET/api/v1/qr

قائمة رموز QR

قائمة مرقّمة لرموز QR في مساحتك.

curl -s "https://www.qra.cc/api/v1/qr?page=1&limit=20" \
  -H "Authorization: Bearer qrf_live_..."
POST/api/v1/qr

إنشاء رمز QR

ينشئ رمزاً ديناميكياً جديداً (وفق حد عدد الرموز في خطتك).

curl -s "https://www.qra.cc/api/v1/qr" \
  -H "Authorization: Bearer qrf_live_..." \
  -H "Content-Type: application/json" \
  -d '{"name":"Q4 insert","type":"url","destination":"https://example.com/q4"}'
GET/api/v1/qr/{id}

جلب رمز QR

اجلب رمزاً واحداً حسب المعرّف.

curl -s "https://www.qra.cc/api/v1/qr/<id>" \
  -H "Authorization: Bearer qrf_live_..."
PATCH/api/v1/qr/{id}

تعديل رمز QR

حدّث الاسم أو الوجهة أو الحالة (نشط/موقوف/منتهي).

curl -s -X PATCH "https://www.qra.cc/api/v1/qr/<id>" \
  -H "Authorization: Bearer qrf_live_..." \
  -H "Content-Type: application/json" \
  -d '{"destination":"https://example.com/new-url"}'
DELETE/api/v1/qr/{id}

حذف رمز QR

احذف رمزاً وجميع عمليات مسحه نهائياً.

curl -s -X DELETE "https://www.qra.cc/api/v1/qr/<id>" \
  -H "Authorization: Bearer qrf_live_..."
GET/api/v1/qr/{id}/scans

قائمة عمليات المسح

سجل المسح الخام مع الطابع الزمني والدولة والجهاز ونظام التشغيل والمتصفح والمصدر. استخدم since و until للنوافذ الزمنية.

curl -s "https://www.qra.cc/api/v1/qr/<id>/scans?since=2026-04-01T00:00:00Z" \
  -H "Authorization: Bearer qrf_live_..."