مراقبة API

تتيح لك مراقبات API التحقق تلقائيًا من أن نقاط نهاية API لديك متاحة وتعمل بكفاءة وتعيد البيانات الصحيحة. تساعد هذه العملية على ضمان عمل تطبيقاتك وتكاملاتك على النحو المطلوب.

مثل المراقبات الأخرى، إذا اكتشفت مراقبة API مشكلة، يمكنك العمل مع فريقك لحل الحادثة وتحديث صفحة الحالة إن أردت.

الميزات الأساسية

• اختبار نقاط نهاية API من مواقع عالمية متعددة كل ٣٠ ثانية.
• التحقق من رموز حالة HTTP ومحتوى JSON والترويسات وأزمنة الاستجابة.
• تضمين ترويسات مخصصة أو معاملات استعلام أو حمولات JSON.
• تلقي إشعارات فورية إذا كانت نقطة النهاية متوقفة أو بطيئة أو تعيد نتائج غير متوقعة.
• التكامل مع Slack والبريد الإلكتروني والرسائل القصيرة والمكالمات الهاتفية والويب هوك وغيرها.

إضافة أول مراقبة API لديك

لإنشاء مراقبة، انتقل إلى مشروعك ← المراقبات ← إضافة مراقبة.

نوع المراقبة

اختر API كنوع للمراقبة.

أدخل رابط نقطة النهاية التي تريد مراقبتها — على سبيل المثال،
https://api.yourservice.com/v1/users.

ضبط الطلب

يمكنك تخصيص طلب API بالكامل:

• طريقة HTTP: GET أو POST أو PUT أو PATCH أو DELETE أو OPTIONS أو HEAD
• المحتوى: أرسل JSON أو بيانات نموذج أو GraphQL أو نصًا عاديًا مع طلبك
• المصادقة: أضف مصادقة أساسية أو مفتاح API أو تفويضًا برمز Bearer
• معاملات الاستعلام: أضف أزواج مفتاح/قيمة إلى رابط طلبك
• الترويسات: أضف الترويسات المخصصة التي يحتاجها طلب API لديك

يُعتبر المراقبة ناجحًا إذا

تنجح مراقبة API عندما تتحقق جميع الشروط المحددة.
يمكنك ضبط واحد أو أكثر من التحققات التالية:

• رمز الحالة: مثلًا أن تكون الاستجابة 200 OK
• زمن الاستجابة: مثلًا أقل من 1 second
• المحتوى يتضمن: مثلًا "success": true
• مسار JSON: مثلًا أن يساوي data.status القيمة "active"
• الترويسة تتضمن: مثلًا Content-Type: application/json

إذا لم يتحقق أي من هذه الشروط، ستُعتبر المراقبة متوقفة، وستُرسل التنبيهات بناءً على إعدادات التنبيهات لديك.

إعدادات متقدمة

• اسم مألوف: امنح مراقبتك اسمًا وصفيًا لتسهيل التعرف عليها.
• تشغيل الفحوصات كل: حدد عدد مرات اختبار نقطة النهاية.
• التشغيل من: اختر مواقع الاختبار (الولايات المتحدة، كندا، أوروبا، آسيا).
• إضافة إلى صفحة الحالة: اعرض مدة تشغيل API وإحصاءات الاستجابة علنًا.
• عند فشل المراقبة: ابدأ حادثة، أو أشعِر المشتركين، أو انشرها في صفحة الحالة.
• عند تعافي المراقبة: حل الحوادث وحدّث صفحة الحالة تلقائيًا.