مرجع API

توثيق API كامل مع أمثلة ونقاط نهاية ومقتطفات كود لدمج خدمات TechRam.

قريباً: توثيق API الشامل لدينا قيد التطوير حالياً. سنوفر API الكامل في أقرب وقت ممكن. ترقبوا التحديثات!

1. مقدمة

يسمح TechRam API للمطورين بدمج خدمات TechRam في تطبيقاتهم. يوفر RESTful API الخاص بنا وصولاً برمجياً إلى وظائف TechRam، مما يتيح لك بناء تكاملات مخصصة وأتمتة سير العمل.

سيغطي هذا التوثيق المصادقة ونقاط النهاية وتنسيقات الطلب/الاستجابة ومعالجة الأخطاء وأفضل الممارسات لاستخدام TechRam API.

2. المصادقة

تتطلب جميع طلبات API المصادقة باستخدام مفاتيح API. قم بتضمين مفتاح API الخاص بك في رؤوس الطلب:

Authorization: Bearer YOUR_API_KEY

يمكن إنشاء مفاتيح API من لوحة تحكم حساب TechRam الخاص بك. احتفظ بمفاتيح API الخاصة بك آمنة ولا تعرضها أبداً في كود جانب العميل أو المستودعات العامة.

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

يجب إجراء جميع طلبات API إلى عنوان URL الأساسي التالي:

https://api.techramllc.com/v1

جميع نقاط النهاية نسبية لهذا العنوان الأساسي. على سبيل المثال، للوصول إلى نقطة نهاية المشاريع، ستستخدم:

https://api.techramllc.com/v1/projects

4. نقاط نهاية API

يوفر TechRam API نقاط النهاية التالية:

المشاريع

GET /projects

استرداد قائمة بجميع المشاريع المرتبطة بحسابك.

إنشاء مشروع

POST /projects

إنشاء مشروع جديد. المعاملات المطلوبة:

المعامل	النوع	مطلوب	الوصف
name	string	نعم	اسم المشروع
description	string	لا	وصف المشروع

5. تنسيق الطلب والاستجابة

تنسيق الطلب

يجب أن تتضمن جميع الطلبات الرؤوس التالية:

                    Content-Type: application/json
Authorization: Bearer YOUR_API_KEY
                

يجب أن تكون أجسام الطلب مشفرة JSON.

تنسيق الاستجابة

يتم إرجاع جميع الردود بتنسيق JSON. استجابة نجاح نموذجية:

                    {
  "success": true,
  "data": { ... },
  "message": "Operation successful"
}
                

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

يستخدم API رموز حالة HTTP القياسية للإشارة إلى النجاح أو الفشل:

200 OK: الطلب نجح
201 Created: تم إنشاء المورد بنجاح
400 Bad Request: معاملات طلب غير صالحة
401 Unauthorized: المصادقة مطلوبة أو مفتاح API غير صالح
404 Not Found: المورد غير موجود
500 Server Error: خطأ في الخادم الداخلي

تتضمن استجابات الخطأ حقل رسالة مع تفاصيل حول ما حدث خطأ.

7. تحديد المعدل

لضمان الاستخدام العادل، ينفذ API تحديد المعدل:

الخطط القياسية: 100 طلب في الدقيقة
الخطط المميزة: 500 طلب في الدقيقة
الخطط المؤسسية: حدود مخصصة

يتم تضمين معلومات حد المعدل في رؤوس الاستجابة. إذا تجاوزت الحد، ستحصل على استجابة 429 طلبات كثيرة جداً.

8. أمثلة الكود

مثال JavaScript

                    fetch('https://api.techramllc.com/v1/projects', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data));
                

مثال PHP

                    $ch = curl_init('https://api.techramllc.com/v1/projects');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  'Authorization: Bearer YOUR_API_KEY',
  'Content-Type: application/json'
]);
$response = curl_exec($ch);
curl_close($ch);
                

9. الدعم والموارد

للحصول على مساعدة وموارد إضافية:

تحتاج مساعدة؟ فريق الدعم لدينا متاح على مدار الساعة طوال أيام الأسبوع. اتصل بنا على info@techramllc.com للأسئلة المتعلقة بـ API.