تتيح واجهة REST API v1 لأنظمتك الخاصة إدارة الرموز وقراءة إحصاءات المسح ورفع الملفات المستضافة وتسجيل التحويلات وإدارة نقاط نهاية الـ webhook. يعتمد الوصول إلى API على خطتك.

إنشاء مفتاح

  1. افتح مفاتيح API في لوحة التحكم وأنشئ مفتاحًا.
  2. اختر النطاق. يمكن لمفاتيح القراءة فقط استدعاء نقاط نهاية GET. ويمكن لمفاتيح الكاملة الإنشاء والتحديث والحذف.
  3. انسخ المفتاح عندما يُعرض. يُعرض السر الكامل مرة واحدة عند الإنشاء ولا يُخزَّن أو يُعرض مجددًا أبدًا.
مفاتيح API، مع النطاق ووقت آخر استخدام لكل مفتاح
مفاتيح API، مع النطاق ووقت آخر استخدام لكل مفتاح

الاتصال بالواجهة

أرسل المفتاح كترويسة تفويض:

bash
curl https://dynamihost.com/api/v1/codes \
  -H "Authorization: Bearer <redacted>"

إنشاء رمز:

bash
curl -X POST https://dynamihost.com/api/v1/codes \
  -H "Authorization: Bearer <redacted>" \
  -H "Content-Type: application/json" \
  -d '{"name": "Counter menu", "type": "url", "destination": "https://example.com/menu"}'

قواعد توفّر وقت تصحيح الأخطاء

  • استخدم أضيق نطاق يعمل. تحتاج مهمة إعداد تقارير إلى مفتاح قراءة، لا مفتاح كامل.
  • مفتاح واحد لكل نظام. لا ينبغي أن يؤدي إلغاء مفتاح مُسرَّب إلى إسقاط ثلاثة تكاملات.
  • احترم حدود المعدل. تتضمن الردود حالة الحد؛ أبطئ بدلًا من إعادة المحاولة في حلقة ضيقة.
  • دوّر المفاتيح ككلمات المرور. أنشئ المفتاح الجديد وانشره وأكّد نجاح المكالمات، ثم ألغِ القديم.