HARPLINK ↗HARPLINK DEVELOPERSمساحة المطور ↗متجر التطبيقات ↗
OFFICIAL SANDBOX

جرّب الربط على بيئة HARPLINK التجريبية

https://demo.harplink.net ↗ · اسم المستخدم: demo · كلمة المرور: demo

بيئة مشتركة للفحص ببيانات تجريبية. تظهر نتائج عمليات الكتابة داخل ERP وقد يغيّرها مستخدمون آخرون؛ استخدم بيانات وهمية. كل طلب API يتطلب توكناً والصلاحيات اللازمة. لربط شركة فعلية غيّر عنوان ERP واستخدم حسابها المخوّل.

اختر العملية وافحصها من المتصفح ←

تنزيل مرجع OpenAPI ↓

العملاء والموردون

partner_api_list

قراءة العملاء والموردين وبقية الأطراف ضمن شركة المستخدم.

دليل العملية
GET
/partners/api/list/
AUTHENTICATION

الوصول والصلاحيات

Authorization: Bearer <access_token>

يمكن لواجهة ERP الداخلية استخدام الجلسة الحالية مع CSRF. هوية المستخدم وصلاحياته وقواعد العملية تحدد الوصول إلى البيانات.

partners.partner.view
الصلاحيات المذكورة مباشرة في تنفيذ المسار. قد تطبق الخدمات شروطاً إضافية.

معلمات الاستعلام

المعلمةالتفاصيل
kindstringall أو customers أو vendors أو drivers أو delivery_companies. الافتراضي all.
qstringبحث بالكود والاسم والاسم القانوني والهواتف والبريد والرقم الضريبي؛ أول خمسة أجزاء من البحث.
activestringall أو active أو inactive. الافتراضي all.
pageintegerرقم الصفحة يبدأ من 1. الصفحات الزائدة تعود إلى الصفحة الأخيرة.
page_sizeintegerمن 10 إلى 100؛ الافتراضي 25. تُضبط القيم خارج المجال إلى حدوده.

استجابة توضيحية

200 OK
{
  "ok": true,
  "data": [
    {
      "id": 123,
      "code": "C-00123",
      "name": "Example Customer",
      "image_url": "",
      "purchase_display_name": "Example Customer",
      "legal_name": "",
      "partner_type": 1,
      "partner_type_name": "Customer",
      "phone": "",
      "phone_secondary": "",
      "address": "",
      "address_line2": "",
      "email": "",
      "tax_number": "",
      "currency": "IQD",
      "currency_id": 1,
      "credit_limit": "0",
      "enforce_credit_limit": false,
      "payment_terms": "",
      "sales_price_tier": 1,
      "is_active": true,
      "branch_name": "Example Branch",
      "account_ar": "",
      "account_ap": "",
      "accounts_ar": [],
      "accounts_ap": []
    }
  ],
  "meta": {
    "summary": {
      "total": 1,
      "customers": 1,
      "vendors": 0,
      "drivers": 0,
      "inactive": 0
    },
    "pagination": {
      "page": 1,
      "page_size": 25,
      "total": 1,
      "pages": 1,
      "has_previous": false,
      "has_next": false
    }
  }
}

تتطلب صلاحية partners.partner.view وسياق شركة صالحاً. النتائج مقيدة بشركة المستخدم وتشمل فروعها.

تستخدم page ولا تستخدم cursor. الترتيب حسب الاسم ثم المعرف. 400 عند رقم صفحة أو حجم غير قابل للتحويل إلى عدد.

meta.summary محسوبة بعد تصفية kind وقبل active وq؛ total في pagination يعبر عن النتائج بعد جميع الفلاتر.

credit_limit نص مالي. كل عنصر في accounts_ar وaccounts_ap يتضمن code وbranch_name وis_primary. الأمثلة توضيحية.

التعامل مع الأخطاء

400راجع بيانات الطلب
401أعد المصادقة
403راجع صلاحية الحساب
429انتظر قبل إعادة المحاولة
REQUEST BUILDER

جهّز مثال الربط

خصّص المعلمات وانسخ المثال إلى تطبيقك.

إضافة معلمات استعلام
TRY THIS ENDPOINT

جرّب الطلب على نظام ERP الخاص بك

الحصول على توكن من المتصفح

أدخل عنوان ERP في الأعلى ثم بيانات حساب ERP، وليس حساب المنصة. بيانات الدخول تُرسل مباشرةً إلى ERP، ولا تُحفظ في المنصة.

أدخل التوكن أو client-uuid.secret بدون اسم نوع المصادقة. يُستخدم لهذا الطلب ولا يُحفظ في المتصفح.

يمكنك تسجيل الدخول أعلاه أو إدخال توكن لديك. هذه تجربة فعلية؛ عمليات الإنشاء والتعديل والحذف قد تغيّر بيانات ERP.

cURL

مرّر التوكن من التخزين الآمن في تطبيقك. الأمثلة تستخدم متغيراً للتوكن وتُولّد محلياً.

حقول ظاهرة في تنفيذ العملية

هذه أسماء مستخرجة من الكود، وقد توجد حقول إضافية أو شروط تعتمد على نوع العملية. راجع عقد العملية ونتيجة الفحص.

حقول الاستجابة

data meta ok