تخط إلى المحتوى الرئيسي
العودة إلى الرئيسية

وثائق API

دمج Warrantee مع أنظمة ERP والمتاجر والأنظمة الداخلية

إنشاء رمز تكاملانضم كبائع

الرابط الأساسي

https://warrantee.io/api/v1

المصادقة

الوصول للواجهة محصور بمستخدمي Warrantee المسجلين. استخدم رمز Bearer للمستخدم أو أنشئ رمز تكامل مخصص عبر x-api-key.

Authorization: Bearer YOUR_SUPABASE_ACCESS_TOKEN
x-api-key: YOUR_SERVER_INTEGRATION_TOKEN

حدود الطلبات: 100 طلب في الدقيقة لكل مستخدم مسجل أو رمز تكامل، مع حدود إضافية على IP لمنع الإساءة.

نموذج الأمان

كل طلب ضمان يتطلب مصادقة، ويقتصر على سجلات المالك أو البائع أو المصدر للمستخدم المحدد، مع حدود طلبات ورؤوس no-store.

تتضمن الاستجابات X-RateLimit-Limit و X-RateLimit-Remaining و X-RateLimit-Reset و Cache-Control: no-store و Vary: Authorization, x-api-key.

رموز التكامل

أنشئ حتى 20 رمزاً نشطاً من جلسة مسجلة. يظهر السر مرة واحدة، ويتم حفظ الهاش فقط، مع صلاحيات قراءة/كتابة وتاريخ انتهاء وإلغاء.

إنشاء رمز

POST /api/integration-tokens

إلغاء رمز

DELETE /api/integration-tokens/:id
{ "name": "ERP production", "scopes": ["warranties:read", "warranties:write"], "rate_limit_per_minute": 100 }

الصلاحيات: warranties:read للقراءة و warranties:write للإنشاء والتحديث والحذف.

ملاحظات التكامل

استخدم Idempotency-Key مع طلبات الإنشاء، وحافظ على رقم مرجعي ثابت متى أمكن، واستخدم رموز تكامل محددة الصلاحيات لمزامنة ERP.

Idempotency-Key: 8f5d07d0-erp-order-102044

نقاط الوصول

GET/api/v1/warrantiesقائمة الضمانات
المعلمات: page, limit, status, category
POST/api/v1/warrantiesإنشاء ضمان
المعلمات: product_name*, start_date*, end_date*, description, serial_number, category, supplier, seller_name, seller_email
GET/api/v1/warranties/:idعرض ضمان
المعلمات: id (path)
PUT/api/v1/warranties/:idتحديث ضمان
المعلمات: product_name, start_date, end_date, status, category, supplier
DELETE/api/v1/warranties/:idحذف ضمان
المعلمات: id (path)

Example Request

curl -X GET "https://warrantee.io/api/v1/warranties?page=1&limit=10" \
  -H "Authorization: Bearer YOUR_TOKEN"