وثائق API
تعلم كيفية دمج Mercozy API لإدارة المنتجات والطلبات والمخزون والمزيد.
البدء
1
احصل على مفتاح API
سجل دخول كمسؤول وانتقل إلى الإعدادات > التكامل > مفاتيح API لإنشاء مفتاح جديد. المسؤولون فقط لديهم الصلاحية.
2
أضفه في الطلبات
أضف رأس X-API-Key إلى جميع طلبات API الخاصة بك.
3
ابدأ بإرسال الطلبات
استخدم أي عميل HTTP للتفاعل مع نقاط نهاية Mercozy API.
المصادقة
تتطلب جميع طلبات API مفتاح API صالحاً يُرسل عبر رأس X-API-Key.
bash
curl https://api.mercozy.com/api/v1/external/products \
-H "X-API-Key: mk_live_your_key_here"عنوان URL الأساسي
https://api.mercozy.com/api/v1/externalحدود المعدل
تعتمد حدود معدل API على خطة اشتراكك.
| الخطة | حد المعدل | وصول API |
|---|---|---|
| Free / Standard | لا يوجد وصول API | No |
| Pro | 300 طلب/دقيقة | Yes |
| Business | 1,000 طلب/دقيقة | Yes |
تنسيق الاستجابة
تُعاد جميع الاستجابات بتنسيق JSON.
استجابة ناجحة
json
{
"data": [
{
"id": "prod_abc123",
"name": "Premium Widget",
"price": 2999,
"currency": "USD"
}
],
"meta": {
"total": 42,
"page": 1,
"limit": 20
}
}استجابة خطأ
json
{
"statusCode": 401,
"message": "Invalid API key",
"error": "Unauthorized"
}رموز الخطأ
| الرمز | الحالة | الوصف |
|---|---|---|
VALIDATION_ERROR | 400 | معاملات طلب غير صالحة |
UNAUTHORIZED | 401 | مفتاح API غير صالح أو مفقود |
FORBIDDEN | 403 | صلاحيات غير كافية |
NOT_FOUND | 404 | المورد غير موجود |
CONFLICT | 409 | المورد موجود بالفعل أو تعارض |
RATE_LIMITED | 429 | طلبات كثيرة جداً |
INTERNAL_ERROR | 500 | خطأ داخلي في الخادم |