البداية
أول طلب في عشر دقائق
هذا الدليل يأخذك من الصفر إلى أول رد ناجح من بيئة الاختبار. لا تحتاج إلا إلى مفتاح اختبار وسطر أوامر.
قبل أن تبدأ#
يصدر فريق ليتس بيتزا (OPT) المفاتيح لكل نظام شريك. اطلب من جهة تواصلك الفنية:
- مفتاح اختبار يبدأ بـ
lpk_test_، ويظهر مرة واحدة فقط عند إصداره. - العنوان الأساسي لبيئة الاختبار (Base URL).
- الفروع التي سيعمل عليها نظامك أثناء الاختبار.
الخطوة 1: جهّز المتغيرات#
كل الأمثلة في هذا الموقع تقرأ العنوان والمفتاح من متغيرين:
export LP_BASE_URL="https://<sandbox address from onboarding>"
export LP_API_KEY="lpk_test_…"الخطوة 2: اطلب GET /partner/v1/me#
أول طلب لأي مفتاح جديد. أي مفتاح صالح يستطيع استدعاءه، ويخبرك من أنت وما يحق لك.
curl -sS "$LP_BASE_URL/partner/v1/me" \
-H "Authorization: Bearer $LP_API_KEY"الخطوة 3: اقرأ الرد#
{
"partner": {
"id": "ptn_01JD5ZB2",
"name": "Business Central (EDM)",
"kind": "erp"
},
"key": {
"id": "key_01JD5ZC9",
"env": "sandbox",
"label": "EDM sandbox",
"prefix": "lpk_test_Ab3d",
"scopes": [
"branches:read",
"catalog:read",
"catalog:write",
"availability:write",
"orders:read",
"orders:ack",
"orders:status",
"orders:cancel",
"orders:events",
"payments:read",
"reports:read",
"webhooks:manage",
"mappings:write"
],
"branches": null,
"ratePerMinute": 600,
"expiresAt": null
},
"environment": "sandbox",
"settings": {
"orders": {
"delivery": "pull",
"acceptance": "partner",
"ackMinutes": 3,
"statuses": [
"accepted",
"rejected",
"preparing",
"ready",
"picked_up",
"cancelled"
],
"connector": null
},
"catalog": {
"source": false,
"fields": [
"names",
"prices",
"sizes",
"groups",
"options",
"categories",
"availability"
],
"publish": "manual",
"maxPriceChangePct": 20,
"maxRemovals": 5
},
"availability": true,
"invoices": {
"issuer": "lp"
},
"customerData": "full",
"liveBranches": [
"28"
]
},
"apiVersion": "v1",
"serverTime": "2026-11-19T19:30:12.000+03:00"
}environment- بيئة الخادم الذي أجاب: sandbox في الاختبار. تطابق بيئة المفتاح دائماً.
key.scopes- ما يحق لهذا المفتاح فعله. طلب خارج هذه الصلاحيات يُرفض بالرمز SCOPE_REQUIRED.
settings.orders- كيف تصلك الطلبات ومن يقبلها وأي الحالات يحق لك إبلاغها.
settings.liveBranches- الفروع المفعّلة لنظامك. تبقى فارغة حتى نفعّلها معك.
كل رد يحمل الترويسة X-Request-Id. احتفظ بها في سجلاتك، فهي أول ما يطلبه الدعم.
الخطوة 4: اعرض فروعك#
بالصلاحية branches:read تحصل على الفروع التي يعمل عليها مفتاحك، ومعها رمز كل فرع في نظامك بعد الربط.
curl -sS "$LP_BASE_URL/partner/v1/branches" \
-H "Authorization: Bearer $LP_API_KEY"الخطوة 5: اطلب طلباً تجريبياً#
في بيئة الاختبار فقط تستطيع أن تنشئ طلباً حقيقياً يمر بالتسعير كما يمر طلب العميل، فيصل إلى سحب طلباتك وإشعاراتك وموصّلك. بلا أسطر يكون الطلب مارقريتا واحدة. وعلى الإنتاج يُرفض بالرمز 403 SANDBOX_ONLY. يحتاج الصلاحيتين orders:read وorders:status.
curl -sS -X POST "$LP_BASE_URL/partner/v1/sandbox/orders" \
-H "Authorization: Bearer $LP_API_KEY" \
-H "Content-Type: application/json" \
--data '{
"branchId": "28",
"fulfilment": "pickup",
"paymentMethod": "pay_at_branch"
}'ثم حرّكه بطلبات الحالة، أو اترك ذلك لموظفي فرع الاختبار. ويمكنك فعل كل هذا من المتصفح في مساحة الشريك.
إذا فشل الطلب#
| الرمز | السبب المعتاد |
|---|---|
UNAUTHENTICATED | الترويسة Authorization ناقصة، أو المفتاح منسوخ خطأ، أو ملغى. |
KEY_ENVIRONMENT_MISMATCH | مفتاح اختبار على عنوان الإنتاج أو العكس. |
IP_NOT_ALLOWED | للمفتاح قائمة عناوين مسموحة، وطلبك جاء من خارجها. |
القائمة الكاملة في الأخطاء.