ما تغطّيه الواجهة البرمجية
إنشاء الروابط ووجهاتها وتحديثها، وتوليد تصاميم QR، وقراءة تحليلات المسح، والاشتراك في الويبهوك. والمواصفة منشورة بصيغة OpenAPI ومعروضة من الخادم في صفحة التوثيق، فالعمليات والمعاملات وأشكال الأخطاء قابلة للقراءة دون تشغيل أي شيء.
الأجزاء التي تهمّ خادمك
يقبل كل طلب POST مفتاح منع تكرار، فلا تُنشئ إعادة المحاولة بعد انتهاء المهلة رابطاً ثانياً. وتتبع الأخطاء تفاصيل المشكلة بمعيار RFC 7807 لا غلافاً مرتجلاً، فيستطيع معالج واحد قراءة كل إخفاق تنتجه الواجهة.
وتُوقَّع تسليمات الويبهوك بخوارزمية HMAC-SHA256 بسرٍّ خاص بكل اشتراك، ويحتفظ سجل التسليم بالحالة ورمز الاستجابة والحمولتين معاً، فيمكن تشخيص التسليم الفاشل بدل تخمينه.
والمصادقة برمز Bearer من مفتاح API تنشئه في الإعدادات، محصور في العمليات التي يحتاجها، بحدّ معدّل خاص به وقائمة عناوين IP مسموح بها اختيارية. وتتوفّر OAuth 2.0 للتطبيقات التي تتصرّف نيابةً عن مساحة عمل أخرى.
أي الخطط تتضمّنها
الوصول إلى الواجهة البرمجية متاح في كل الخطط بما فيها المجانية. والذي يختلف بحسب الفئة هو عدد المفاتيح واشتراكات الويبهوك المسموح بها وحصّة الطلبات؛ والأرقام الدقيقة في مقارنة الخطط.