البدء السريع
يستخدم هذا الدليل عنوان UAT https://uat-api.lynq-sa.com/partner. استبدل بيانات الاعتماد بمفاتيح Lynq.
المتطلبات
X-API-KeyوX-Client-IDلـ UAT (اطلب الوصول إن لزم)- نقطة HTTPS لـ webhooks (أو نفق مثل ngrok للتطوير المحلي)
1. إنشاء عرض سعر
curl -X POST 'https://uat-api.lynq-sa.com/partner/quotes' \
-H 'X-API-Key: YOUR_KEY' \
-H 'X-Client-ID: YOUR_CLIENT_ID' \
-H 'Content-Type: application/json' \
-d '{
"pickup": {"lat": 24.7136, "lng": 46.6753, "address": "Riyadh pickup"},
"dropoff": {"lat": 24.768, "lng": 46.709, "address": "Riyadh dropoff"},
"vehicle_type": "motorcycle"
}'
احفظ quote_id — تنتهي صلاحية العروض (افتراضيًا 15 دقيقة).
2. إرسال طلب
curl -X POST 'https://uat-api.lynq-sa.com/partner/orders' \
-H 'X-API-Key: YOUR_KEY' \
-H 'X-Client-ID: YOUR_CLIENT_ID' \
-H 'Content-Type: application/json' \
-d '{
"quote_id": "01KQZ1XFSEACDXV166R7V19EH0",
"partner_order_number": "PO-10042",
"pickup": {
"lat": 24.7136,
"lng": 46.6753,
"short_address": "Warehouse A",
"contact_name": "Ahmed",
"contact_phone": "+966501234567"
},
"dropoff": {
"lat": 24.768,
"lng": 46.709,
"short_address": "Customer building",
"contact_name": "Sara",
"contact_phone": "+966509876543"
}
}'
استجابة 202 Accepted تتضمن ULID الطلب. webhooks مثل order.received تتبع بشكل غير متزامن.
3. تسجيل webhook
curl -X POST 'https://uat-api.lynq-sa.com/partner/webhooks' \
-H 'X-API-Key: YOUR_KEY' \
-H 'X-Client-ID: YOUR_CLIENT_ID' \
-H 'Content-Type: application/json' \
-d '{
"url": "https://your-company.example.com/webhooks/lynq",
"description": "UAT listener",
"event_filters": []
}'
احفظ secret لمرة واحدة من 201 Created. أرسل اختبارًا عبر POST /webhooks/\{id\}/test.
4. التحقق من التوقيعات
استخدم صفحة الأدوات أو المقتطفات في Webhooks.