وثائق API
ادمج نظمك مع منصتنا باستخدام واجهة برمجة التطبيقات REST الشاملة لدينا. الوصول إلى بيانات التبرعات والمشاريع والحملات وبيانات التقارير بشكل برمجي.
ابداً عرض النقاط النهائيةبدء التشغيل
1. احصل على مفتاح API
سجل منظمتك غير الحكومية واطلب الوصول إلى واجهة برمجة التطبيقات من لوحة التحكم الخاصة بك. يتم إصدار مفاتيح واجهة برمجة التطبيقات في غضون 24 ساعة.
2. أتمتة التحقق
استخدم مصادقة رمز الحامل. أدرج مفتاح API الخاص بك في رأس المصادقة لجميع الطلبات.
3. إصدار الطلبات
ابدأ بإجراء مكالمات API لاسترجاع البيانات، وإنشاء التبرعات، وتحديث المشاريع، وتوليد التقارير.
نقاط النهاية المتاحة
GET /api/v1/حملات
قائمة جميع الحملات النشطة مع دعم التصفح الصفحي.
curl -H "التصريح: حامل YOUR_API_KEY" \
https://api.platform.org/api/v1/campaigns
منشور /api/v1/tahseelat
إنشاء سجل تبرع جديد برمجيًا.
curl -X POST -H "Authorization: Bearer المفتاح_API" \
-d '{"مبلغ": 100, "معرف_الحملة": 1}' \
https://api.platform.org/api/v1/tبرعات
GET /api/v1/مشاريع
استرجع جميع المشاريع مع بيانات الحالة والتقدم.
curl -H "Authorization: Bearer المفتاح_API" \
https://api.platform.org/api/v1/projects
GET /api/v1/تقارير
توليد تقارير مالية وتأثيرية.
curl -H "التصريح: حامل YOUR_API_KEY" \
https://api.platform.org/api/v1/reports?type=impact
محددات الحجم
| خطة | طلبات/الساعة | طلبات/يوم |
|---|---|---|
| مجانًا | 100 | 1,000 |
| Pro | 1,000 | 10,000 |
| مَشرُوع | غير محدود | غير محدود |