API للمطوّرين

المصادقة

أنشئ مفتاحاً من لوحة التحكم، قسم API، وأرسله في ترويسة Authorization بصيغة Bearer. احفظ المفتاح كما تحفظ كلمة المرور.

curl https://avintools.ir/api/v1/links \
  -H "Authorization: Bearer avk_…"

حد الطلبات: 120 طلباً في الدقيقة لكل مفتاح. حدود الخطة (عدد الرموز الديناميكية والروابط وفترة الإحصاءات) تنطبق على الـAPI أيضاً.

نقاط الوصول

العنوان الأساسي: https://avintools.ir/api/v1

• GET/linksقائمة الروابط المختصرة
• POST/linksإنشاء رابط مختصر
• GET/links/{id}جلب رابط واحد
• PATCH/links/{id}تغيير الوجهة أو العنوان أو إيقاف الرابط (يبقى الرابط المختصر نفسه)
• DELETE/links/{id}حذف الرابط
• GET/qrقائمة رموز QR
• POST/qrإنشاء رمز QR ثابت أو ديناميكي
• GET/qr/{id}جلب رمز QR واحد
• PATCH/qr/{id}تغيير المحتوى أو التصميم (يبقى الرمز المطبوع نفسه للرموز الديناميكية)
• DELETE/qr/{id}حذف رمز QR
• GET/qr/{id}/svgصورة SVG بسيطة للرمز
• GET/analytics/{id}إحصاءات المسح والنقر لرابط أو رمز ديناميكي

أمثلة

إنشاء رابط مختصر

curl -X POST https://avintools.ir/api/v1/links \
  -H "Authorization: Bearer avk_…" \
  -H "Content-Type: application/json" \
  -d '{"destination":"https://example.com/sale","title":"Sale"}'

إنشاء رمز QR ديناميكي

curl -X POST https://avintools.ir/api/v1/qr \
  -H "Authorization: Bearer avk_…" \
  -H "Content-Type: application/json" \
  -d '{"type":"url","values":{"url":"https://example.com/menu"},"mode":"dynamic","name":"Menu"}'

تغيير وجهة رمز ديناميكي (لا يتغير الرمز المطبوع)

curl -X PATCH https://avintools.ir/api/v1/qr/QR_ID \
  -H "Authorization: Bearer avk_…" \
  -H "Content-Type: application/json" \
  -d '{"values":{"url":"https://example.com/new-menu"}}'

الأخطاء

استجابة الخطأ دائماً JSON برمز ثابت ورسالة بالإنجليزية: 400 طلب غير صحيح، 401 مفتاح غير صالح، 403 خطة بلا API أو بلوغ حد الخطة، 404 غير موجود، 429 طلبات كثيرة.

{ "error": { "code": "plan_limit", "message": "Plan limit reached: dynamicQr." } }

الوصف الكامل للـAPI بصيغة OpenAPI: /api/v1/openapi.json