وثائق المطورين

المطوّر API مرجع

ابنِ تكاملات مخصصة باستخدام REST API الخاص بنا. أدِر الاستبيانات، واجمع الردود، وشغّل الحملات، وادخل إلى التحليلات برمجيًا.

البدء السريع

ابدأ في دقائق

البدء السريع

# Base URL

https://api.claform.com/api/v1

# Authentication: Bearer token in header

curl -H "Authorization: Bearer your_api_key" \

https://api.claform.com/api/v1/surveys

# Response format: JSON

{

"data": [...],

"meta": { "total": 42, "page": 1 }

}

المصادقة

وصول آمن

مفاتيح API

مفاتيح API محددة النطاق بأذونات لكل نقطة نهاية. مرّرها عبر Authorization: Bearer الترويسة.

رموز JWT

رموز Bearer من OAuth 2.0 لطلبات سياق المستخدم. مرّرها عبر Authorization الترويسة.

تحديد المعدل

60 طلبًا/دقيقة افتراضيًا. حدود أعلى في خطط Business (300/دقيقة) وEnterprise (مخصصة).

نقاط النهاية

نقاط نهاية API الأساسية

تستخدم كل نقاط النهاية الـ base URL /api/v1 وتُرجع ردود JSON.

الاستبيانات

GET/surveys
POST/surveys
GET/surveys/:id
PATCH/surveys/:id
DELETE/surveys/:id
GET/surveys/:id/responses

الردود

GET/responses
POST/responses
GET/responses/:id
DELETE/responses/:id

الحملات

POST/email-campaigns
POST/sms-campaigns
POST/whatsapp-campaigns
POST/voice-distribution
GET/email-campaigns/:id

التحليلات

GET/analytics/survey/:id/stats
GET/analytics/survey/:id/trends
POST/analytics/ai/sentiment
POST/analytics/ai/summary

الجماهير

GET/audiences
POST/audiences
POST/audiences/:id/contacts
GET/audiences/:id/contacts

خطافات الويب

POST/webhooks
GET/webhooks
DELETE/webhooks/:id
POST/webhooks/:id/test

حزم التطوير (SDKs)

حزم تطوير رسمية لـ 4 منصات

حزم تطوير جاهزة للإنتاج مع دعم العمل دون اتصال، وأمان الأنواع، ووثائق شاملة.

TypeScript / Node.js
npm install @claform/sdk-core
React Native
npm install @claform/sdk-react-native
Flutter / Dart
flutter pub add claform_sdk_flutter
iOS / Swift
.package(url: "https://github.com/claform/sdk-ios")
Android / Kotlin
implementation "com.claform:sdk-android:1.0.0"

خطافات الويب

16 نوعًا من أحداث خطافات الويب

اشترك في الأحداث واستقبل استدعاءات HTTP فورية عند حدوث إجراءات في حسابك.

survey.created
survey.published
survey.closed
survey.deleted
response.started
response.completed
response.updated
response.deleted
campaign.sent
campaign.delivered
campaign.failed
campaign.bounced
contact.created
contact.opted_out
analytics.report_ready
webhook.test

معالجة الأخطاء

رموز الأخطاء

الرمزالاسمالوصف
400Bad Requestمعاملات أو متن طلب غير صالح
401Unauthorizedمفتاح API مفقود أو غير صالح
403Forbiddenأذونات غير كافية لهذا المورد
404Not Foundالمورد غير موجود
409Conflictتعارض في حالة المورد (مثل التكرار)
422Unprocessableخطأ في التحقق ضمن متن الطلب
429Too Many Requestsتم تجاوز حد المعدل
500Server Errorخطأ خادم غير متوقع

ابدأ البناء اليوم

أنشئ حسابك وولّد مفتاح API في ثوانٍ. الوصول الكامل إلى API متاح في كل الخطط، بما فيها المجانية.

احصل على مفتاح APIموارد المطورين