Get Tools Lab المطورون API
دمج الأدوات والأدلة وسير عمل النظام الأساسي المنشورة باستخدام نقاط نهاية المطور المعتمدة. تعتمد الإمكانيات المتاحة على وحدات واجهة برمجة التطبيقات (API) الممكّنة ومستوى الوصول الخاص بك.
خيارات واجهة برمجة التطبيقات
يتضمن النظام الأساسي نقاط نهاية REST وطبقة خفيفة الوزن متوافقة مع GraphQL، مع دعم لمفاتيح API وبيانات اعتماد عميل OAuth وتحليلات الاستخدام وحدود الأسعار وتسليم خطاف الويب الموقع. لا تتوفر كل ميزات موقع الويب العام تلقائيًا من خلال واجهة برمجة التطبيقات.
المصادقة
يمكن لنقاط نهاية REST v1 استخدام مفتاح API في X-API-Key رأس الصفحة. قد تقبل نقاط النهاية الأحدث أيضًا الرموز المميزة لحاملها المدعومة. احتفظ بسرية جميع بيانات الاعتماد وقم بتدوير المفتاح على الفور إذا تم كشفه.
curl -H "X-API-Key: qc_your_key" "https://gettoolslab.com/api/v1/tools.php"
نقاط نهاية REST الشائعة
أداةs
GET /api/v1/tools.php
GET /api/v1/tools.php?category=PDF
GET /api/v1/tools.php?q=json
دليلs
GET /api/v1/guides.php
GET /api/v1/guides.php?q=image
REST v2 وGraphQL
يمكن للنظام الأساسي للمطورين الموحد الكشف عن مسارات REST وعمليات GraphQL الأحدث للموارد المدعومة. استخدم منطقة المطورون وملعب واجهة برمجة التطبيقات (API) لرؤية نقاط النهاية التي تم تمكينها بالفعل في النشر الحالي.
حدود المعدل
قد تكون طلبات API محدودة بالدقيقة أو باليوم. يمكن للطلب الذي يتجاوز الحد المسموح به إرجاع HTTP 429 Too Many Requests مع معلومات إعادة المحاولة أو إعادة التعيين. يجب أن تستخدم التطبيقات التراجع بدلاً من تكرار الطلبات الفاشلة على الفور.
خطافات الويب
يمكن تسليم الأحداث المدعومة إلى وجهة خطاف الويب HTTPS. عند تمكين التوقيع، تحقق من توقيع HMAC قبل الوثوق بالحمولة. يجب أيضًا على مستهلك خطاف الويب أن يتسامح مع عمليات إعادة المحاولة ويجب أن يجعل معالجة الأحداث غير فعالة حتى لا يؤدي نفس التسليم إلى إنشاء إجراءات مكررة.
خطأs
يمكن أن تؤدي بيانات الاعتماد غير الصالحة أو العملاء المعطلين أو الحصص المستنفدة أو الطلبات المشوهة إلى إرجاع أخطاء JSON منظمة مع رموز حالة HTTP 4xx. تستخدم حالات الفشل من جانب الخادم استجابات 5xx. يجب أن تقوم التطبيقات بتسجيل حالة الاستجابة ومعرف الطلب حيثما كان ذلك متاحًا بدلاً من الكشف عن بيانات الاعتماد السرية في تقارير الأخطاء.
الأمان guidance
- لا تقم مطلقًا بتضمين مفاتيح API السرية في JavaScript للمتصفح العام.
- استخدم HTTPS لواجهة برمجة التطبيقات (API) وحركة مرور الويب.
- امنح العملاء الأذونات التي يحتاجونها فقط.
- التحقق من صحة توقيعات الويب هوك.
- قم بتدوير بيانات الاعتماد المخترقة.
- احترام حدود المعدل الموثقة وحدود حجم الملف.
أدوات تطوير البرامج (SDK) والملعب
قم بزيارة قسم المطورون للحصول على أمثلة SDK والملعب التفاعلي. اختبر عمليات التكامل مع البيانات غير الحساسة قبل استخدام ملفات الإنتاج أو معلومات العميل.