توثيق API
مرجع OpenAPI وواجهة « Try it out »: توثيق API (/api/docs).
جميع المسارات البرمجية تحت /api/merchant/v1.
الوصول إلى API
عند تفعيل واجهة API للتجار، ينشئ مسؤولو الفريق رموز وصول أو رمز webhook الوارد من إعدادات الفريق. لا تُنشأ الرموز عبر واجهة HTTP.
المسارات (ملخص)
- عمليات البحث —
POST /lookups؛GET /lookupsوGET /lookups/{id}(للقراءة فقط). - العملاء —
GET/POST /customers،GET/PUT/PATCH/DELETE /customers/{id}. حذف العميل يحذف أيضًا جميع طلباته (حذف منطقي). لا يمكن تعديل أو حذف عميل لديه طلب معتمد. - الطلبات —
POST/GET /submissions،GET/PUT/PATCH/DELETE /submissions/{id}(المسودة فقط للتعديل؛ السحب عبرDELETE). - Webhooks —
GET/PUT/PATCH /webhooksلـ webhook الصادر.
كل منطقة تتطلب أيضًا علم الميزة (merchant.customers، merchant.submission، إلخ).
النطاق والتدوير
أصدر رموزًا بالحد الأدنى من الصلاحيات. ألغِ أو دوّر الرموز عند مغادرة الموظف أو احتمال التسريب.
Webhooks
عند التفعيل، اضبط نقاط HTTPS وتحقق من التوقيعات بالسر المعروض مرة واحدة.
الأمان
لا تضع الرموز في المستودع ولا تشاركها في الدردشة. استخدم رموزًا منفصلة لكل بيئة.