نظرة عامة على API

تُبنى واجهة KeepFlow البرمجية حول نمط REST. تتميّز واجهتنا البرمجية بعناوين URL متوقَّعة موجَّهة نحو الموارد، وتقبل نصوص طلبات مُرمَّزة بصيغة JSON، وتعيد استجابات مُرمَّزة بصيغة JSON، وتستخدم رموز استجابة HTTP القياسية.

عنوان URL الأساسي

https://api.keepflow.ai/v1

صيغة الطلب

يجب أن تتضمّن جميع الطلبات:

• ترويسة Content-Type: application/json
• ترويسة Authorization: Bearer <api_key>

صيغة الاستجابة

تتبع جميع الاستجابات بنية متسقة:

{
  "data": { ... },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2026-03-15T10:30:00Z"
  }
}

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

تعيد الأخطاء رموز حالة HTTP المناسبة مع رسالة وصفية:

{
  "error": {
    "code": "invalid_request",
    "message": "The 'email' field is required."
  }
}