مرجع واجهة البرمجة العامة v1

الهدف

مرجع سردي لكل مسار قراءة مُشحن في واجهة البرمجة العامة v1.

لمن

المكاملون وفق AD-003 (قراءة فقط، رموز محدودة النطاق، حد معدل). لا مسارات كتابة.

المواصفة الآلية

نزّل public-api-v1-openapi.yaml.

عنوان الأساس

{origin}/api/v1

المصادقة

المتطلب	التفصيل
المخطط	Authorization: Bearer {sanctum_token}
نطاق المنشأة	القدرة tenant:{uuid}
نطاق المورد	قدرة api:* إضافية
مسارات CRM	وحدة crm مفعّلة وإلا 422

القدرات

القدرة	المسارات
(المنشأة فقط)	GET /meta
api:parties.read	/parties, /parties/{party}
api:items.read	/items, /items/{item}
api:inventory.read	/inventory/availability
api:sales.read	/sales-invoices
api:purchases.read	/purchase-bills
api:crm.read	/crm/leads, /crm/opportunities

مثال إنشاء رمز

$user->createToken('integration', [
    'tenant:'.$tenantId,
    'api:parties.read',
    'api:items.read',
])->plainTextToken;

قدرة ناقصة ← 403.

حد المعدل

throttle:120,1 — 120 طلب/دقيقة.

عزل المنشأة

المنشأة من الرمز فقط. عبر المنشآت ← 404.

التصفح

page افتراضي 1؛ per_page افتراضي 25 وحد أقصى 100.

المسارات

• GET /meta — إصدار الواجهة ومعرّف المنشأة
• الأطراف والكتالوج والتوفر والفواتير المرحّلة وفواتير المشتريات المرحّلة وقراءات CRM كما في النسخة الإنجليزية

ليس في v1

الكتابة؛ مسارات SPA للموظفين؛ البوابة؛ POS الداخلي؛ الويب هوكات.

ذات صلة

• نظرة عامة
• OpenAPI
• محور المكامل