البدء في 3 خطوات

  1. أنشئ حسابك واحصل على الوصول إلى لوحة DZ Relay (انظر كن تاجرًا).
  2. أنشئ مفتاح API في اللوحة ضمن الإعدادات → مفاتيح API. المفتاح بصيغة dzlk_… ويُعرَض مرة واحدة فقط.
  3. قم بأول استدعاء للتحقّق من تكاملك:
    curl -H "Authorization: ApiKey dzlk_..." \
      /api/partner/v1/health
    يُعيد إليك الخادم معرّف مؤسستك ويؤكّد أن مفتاحك صالح.

إنشاء طرد

curl -X POST \
  -H "Authorization: ApiKey dzlk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "recipientName": "Hocine Benali",
    "recipientPhone": "0555 12 34 56",
    "weightG": 1500,
    "destinationRelayCode": "DZ-ALG-001"
  }' \
  /api/partner/v1/parcels

Webhooks

لتلقّي تغييرات الحالة عبر الدفع، اضبط عنوان URL + سرّ HMAC في الإعدادات → Webhooks. كل إشعار هو طلب POST موقّع بـ HMAC-SHA256 — تحقّق من التوقيع عبر الترويسة X-Dzrelay-Signature قبل معالجة الحمولة.

المرجع الكامل

وثائق تفاعلية مولّدة من مواصفات OpenAPI 3 للخادم. يمكنك أيضًا الحصول على JSON الخام: /v3/api-docs/partner (قابل للاستخدام مع OpenAPI Generator لإنشاء SDK بلغة Java / PHP / Go / TypeScript).