API والمستندات

مفتاح واحد. كل وحدة.

تمنحك معظم برامج الأعمال واجهة برمجة تطبيقات (API) لكل منتج — واحدة لنقطة البيع، وأخرى للمخزون، وثالثة للفواتير، ولكل منها مصادقتها الخاصة وفهمها الخاص للتاريخ. Kardopal لديها واحدة. نفس المفتاح، ونفس عنوان URL الأساسي، ونفس قواعد الاستعلام تصل إلى 129 موردًا عبر 29 وحدة.

29
الوحدات
129
الموارد
1
مفتاح، عنوان URL أساسي واحد
200
الحد الأقصى للصفوف لكل صفحة

لماذا تستحق واجهة برمجة التطبيقات (API) هذه البناء عليها.

ستة أمور صحيحة هنا وعادة ما لا تكون كذلك.

يصف نفسه

اضرب عنوان URL الأساسي وسيعيد API كتالوجه الخاص — كل وحدة يمكن لمفتاحك رؤيتها، كل مورد بداخلها، الحقول القابلة للبحث والترشيح. لا تحتاج هذه الصفحة لكتابة التكامل؛ بل تحتاجها لاتخاذ القرار.

صلاحيات تتحكم فعليًا

يتم إنشاء النطاقات والمسارات وأذونات التطبيق من قائمة واحدة، لذلك لا يمكن تقديم إذن ما لم يكن هناك نقطة نهاية خلفه. مفتاح محدد النطاق لـ العناصر يجلب العناصر — طلب كشوف الرواتب منه يعيد 403، وليس صفحة فارغة صامتة.

قواعد استعلام واحدة، في كل مكان

بحث, منذ, حتى, تخطي و أخذ تعني نفس الشيء في الفواتير كما في حركات المخزون. تعلم الشكل مرة واحدة وكل واحد من الموارد الـ 133 يستجيب له.

مساحتك الخاصة، ولك وحدك

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

الحقول تحافظ على دقتها

تُقرأ قائمة الحقول من المخطط الحي عند التشغيل بدلاً من صيانتها يدوياً. يظهر عمود جديد تلقائياً؛ ولا يمكن لعمود تم إسقاطه أن يترك مرجعاً معلقاً في المستندات أو خطأ 500 عند أول استدعاء.

للقراءة فقط، عن قصد

المفاتيح تقرأ؛ لا تكتب أبدًا. التكامل الذي يخطئ لا يمكنه إلغاء فاتورة أو نقل مخزون. أي شيء يغير سجلًا يمر عبر التطبيق أو تسجيل دخول الموظفين، حيث يُنسب إلى شخص ويسجل في سجل التدقيق.

ابدأ بطلب واحد

كل شيء هو طلب GET. إذا كان بإمكانك استخدام curl، يمكنك استخدام هذا.

احصل /api/v1الكتالوج الكامل الذي يمكن لمفتاحك رؤيته.
curl https://api.kardopal.com/api/v1 \
  -H "X-API-Key: kp_live_…"
احصل /api/v1/meفحص السلامة — لمن هذا المفتاح، وماذا يمكنه أن يقرأ.
{
  "authType": "api_key",
  "tenant": { "name": "Nova Retail", "plan": "pro" },
  "scopes": ["items", "sales", "pos"]
}
احصل /api/v1/items?search=lamp&take=2أي مورد، بنفس الشكل.
{
  "resource": "items",
  "scope": "items",
  "total": 41,
  "skip": 0,
  "take": 2,
  "hasMore": true,
  "data": [ { "id": "…", "name": "Desk Lamp LED" } ]
}
احصل /api/v1/meta/countsعدد الصفوف لكل مورد — شاهد البيانات الموجودة فعليًا
curl https://api.kardopal.com/api/v1/meta/counts \
  -H "X-API-Key: kp_live_…"

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

معاملهلالملاحظات
بحثمطابقة غير حساسة لحالة الأحرف عبر حقول المورد القابلة للبحث.الحقول المذكورة مدرجة في /meta
منذالسجلات من هذا التاريخ فصاعداً فقطينطبق على الحقل الذي يتم الفرز به للمورد
حتىالسجلات حتى هذا التاريخ فقطدمج مع منذ لفترة
تخطيإزاحة ضمن مجموعة النتائجالقيمة الافتراضية 0
أخذكم عدد الصفوف المراد إرجاعهاالافتراضي 50، والحد الأقصى 200

تقبل الموارد أيضًا عوامل تصفية المطابقة التامة على حقولها المعلنة — ?الحالة=مدفوع, ?warehouseId=… — وكل منها يعلن عن هذه الخصائص. كل استجابة قائمة تحمل الإجمالي و يوجد المزيد، لذا فإن التصفح دورة، وليس تخميناً.

ما تصل إليه واجهة API

29 وحدة، 129 موردًا. كل بطاقة هي إذن واحد يمكنك منحه لمفتاح — والعلامة الرمادية هي حيث توجد نفس السجلات في التطبيق على هاتفك.

جهات الاتصال

2

العملاء، الموردون، والقطاعات التي ينتمون إليها.

جهات الاتصالشرائح جهات الاتصال
جهات الاتصال جهات الاتصال

الأصناف

7

الكتالوج: المنتجات، المتغيرات، العلامات التجارية، قوائم الأسعار والوحدات.

العناصرالفئاتعلامات تجاريةمتغيرات الأصنافقوائم الأسعاروحدات+1 المزيد
العناصر الأصناف

المخزون

7

المستودعات، مستويات المخزون، التحركات، الدفعات، الأرقام التسلسلية، والمواقع التخزينية.

المستودعاتحركات المخزونمستويات المخزوندفعاتالأرقام التسلسليةجرد-المخزون+1 المزيد
المخزون المخزون

المبيعات

7

الفواتير، التقديرات، الطلبات، إشعارات الائتمان، والمدفوعات.

الفواتيرتقديراتطلبات المبيعاتإشعارات دائنةالمدفوعاتفواتير متكررة+1 المزيد
المبيعات المبيعات

POS

11

صناديق البيع، الورديات، الإيصالات، الطاولات وكل عملية بيع تمت عبر الكاونتر.

مبيعات نقاط البيعورديات نقاط البيعأجهزة نقاط البيعمستخدمو نقاط البيعطاولات POSمناطق-طاولات-POS+5 المزيد
pos POS

CRM

4

العملاء المحتملون، الصفقات، مسارات المبيعات والمقترحات.

العملاء المحتملونالصفقاتمسارات العملمقترحات
crm CRM

الشراء

5

أوامر الشراء، الطلبات، المرتجعات، الفواتير، ومدفوعات الموردين.

أوامر الشراءطلبات الشراءمرتجعات-المشترياتالفواتيرمدفوعات-الموردين
شراء الشراء

المحاسبة

5

المصروفات، الحسابات المصرفية، المعاملات، ومعدلات الضرائب.

المصروفاتفئات المصروفاتالحسابات-المصرفيةbank-transactionsأسعار الضرائب
المحاسبة المحاسبة

التسويق

4

حملات، مستلمون، صفحات هبوط، وتقديمات نماذج.

حملاتمستلمو-الحملاتالصفحات المقصودةإرسالات النماذج
التسويق التسويق

HR

8

الموظفون، الأقسام، الإجازات، كشوف الرواتب، الحضور والتوظيف.

الموظفونالأقسامleave-requestsكشوف الرواتبالحضورإعلانات الوظائف+2 المزيد
hr HR

جدول الدوام.

2

إدخالات الوقت والمشاريع التي تُسجل عليها.

إدخالات الوقتمشاريع جدول الدوام
جدول الدوام جدول الدوام.

المشاريع

3

مشاريع، مراحل، والتكاليف المرتبطة بها.

المشاريعمراحل المشروعتكاليف المشاريع
المشاريع المشاريع

الحجز

3

المواعيد، الخدمات القابلة للحجز والموظفون الذين يقدمونها.

الحجوزاتخدمات الحجزحجز-الموظفين
الحجز الحجز

الخدمة الميدانية

7

الوظائف، الفنيون، أوامر العمل، العقود والمعدات.

مهام ميدانيةالفنيونطلبات الخدمةعقود الخدمةأوامر العملبطاقات العمل+1 المزيد
خدمة ميدانية الخدمة الميدانية

اللوجستيات.

5

الشحنات، السائقون، المركبات، المناطق، وشركات النقل.

شحناتالسائقونالمركباتمناطق التوصيلشركات الشحن
اللوجستيات اللوجستيات.

مكتب المساعدة

5

التذاكر، سياسات اتفاقية مستوى الخدمة، مقالات المساعدة، وقاعدة المعرفة.

تذاكرتذاكر العملاءمقالات المساعدةقاعدة المعرفةسياسات اتفاقية مستوى الخدمة
الدعم مكتب المساعدة

ما بعد البيع

5

المرتجعات، مطالبات الضمان، الإصلاحات، وتسجيل المنتجات.

rmasمطالبات الضمانتسجيلات الضمانإصلاحاتتسجيلات المنتجات
ما بعد البيع ما بعد البيع

الإيجار

3

الأصول القابلة للتأجير، اتفاقيات الإيجار وبنودها.

الأصولالإيجاراتبنود الإيجار
تأجير الإيجار

مطعم

2

قائمة الطعام والطلبات المقدمة عليها.

عناصر القائمةطلبات القائمة
مطعم المأكولات والمشروبات

قائمة الانتظار

5

التذاكر، الخدمات، العدادات، الفروع وشاشات العرض.

تذاكر الانتظارخدمات الانتظارعدادات الانتظارفروع قائمة الانتظارشاشات الانتظار
قائمة الانتظار قائمة الانتظار

الولاء

6

الأعضاء، الحسابات، المستويات، المكافآت ومعاملات النقاط.

loyalty-membersحسابات الولاءمكافآت الولاءمستويات الولاءمعاملات الولاءloyalty-coupons
ولاء الولاء

المواقع

2

المواقع والفروع.

المواقعالفروع
المواقع المواقع

IOT

6

الأجهزة، المواقع، الصناديق، التنبيهات، الأحداث، ومحتوى اللافتات.

أجهزة إنترنت الأشياءiot-sitesتنبيهات IoTأحداث إنترنت الأشياءصناديق إنترنت الأشياءمحتوى-لافتات-إنترنت-الأشياء
iot IOT Hub

استوديو الذكاء الاصطناعي

3

الأصول المُنشأة، المشاريع التي تحتويها، وسجل المهام.

أصول الذكاء الاصطناعيمشاريع الذكاء الاصطناعيوظائف الذكاء الاصطناعي
ai_studio استوديو الذكاء الاصطناعي

التجارة

3

أعضاء الشبكة، طلبات عروض الأسعار، والتحصيلات.

أعضاء الشبكةطلبات عروض الأسعارالمجموعات
التجارة التجارة

التوقيع الإلكتروني

2

طلبات التوقيع والتوقيعات التي تم جمعها مقابلها.

طلبات التوقيعالتوقيعات
التوقيع التوقيع الإلكتروني

الموافقات

2

طلبات الموافقة والقواعد التي توجهها.

طلبات-الموافقةقواعد الموافقة
الموافقات الموافقات

الملفات

2

الملفات المرفوعة والمستندات الممسوحة ضوئيًا.

الملفاتالمستندات الممسوحة ضوئيًا
الملفات الملفات

النشاط

3

سجل النشاط، سجل التدقيق، والإشعارات.

الأنشطةسجلات التدقيقإشعارات
عبر الهاتف

كل وحدة يقرأها الـ API، يمكن لفريقك فتحها في متناول يدهم.

هذا هو الجزء الذي عادة ما يكون غير صحيح. الكثير من المنصات توفر واجهة برمجة تطبيقات (API) واسعة ثم تقدم تطبيق جوال يقوم بثلاثة أشياء — الموافقة، العرض، الإشعار. تطبيق Kardopal هو المنتج، وليس مجرد رفيق: جميع الوحدات الـ29 المذكورة أعلاه لها شاشات حقيقية، والهاتف هو المكان الذي يحدث فيه معظم العمل فعليًا.

  • اقرأه، ثم تصرف بناءً عليه. يسحب تكاملك مستوى المخزون؛ ويفتح الشخص الذي يجب عليه إصلاحه نفس السجل، ويعدله، ويتم توقيعه باسمه.
  • امسح، صور، وقّع. مسح الباركود، التقاط المستندات والتوقيع الإلكتروني هي ميزات أصلية للهاتف — ليس لها مكافئ مكتبي يستحق الاستخدام.
  • يعمل دون اتصال بالإنترنت عند الكاشير. يستمر الكاشير وشاشة المطبخ وشاشة قائمة الانتظار في العمل عند انقطاع الاتصال.
  • نفس تسجيل الدخول، نفس البيانات، 20 لغة. بما في ذلك من اليمين إلى اليسار، حتى لا يقرأ الفريق الناطق بالعربية تخطيطًا معكوسًا.
اطلع على المنصة.
تطبيق Kardopal يعمل على الهاتف

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

افتح التطبيق، اذهب إلى المنصة ← مفاتيح API.يتم إنشاء المفاتيح بواسطة مالك أو مسؤول على حسابك الخاص. لا أحد في Kardopal يصدرها لك.
حدد فقط الوحدات التي تحتاجها عملية التكامل.عنصر واجهة متجر يحتاج العناصر. لا يحتاج إلى hr. المفاتيح الضيقة آمنة في حالة الفشل.
أرسلها كعنوان (header)، وليس في عنوان URL أبدًا.X-API-Key: kp_live_… — سلاسل الاستعلام تنتهي في السجلات، الخوادم الوكيلة (البروكسيات) وسجل المتصفح.
قم بالتدوير بإنشاء المفتاح الجديد أولاً.يعمل كلاهما في وقت واحد، بحيث يمكنك نقل حركة المرور وإلغاء القديم دون أي فترة توقف.

ابنِ شيئًا عليه

توثق واجهة برمجة التطبيقات نفسها: أنشئ مفتاحًا في التطبيق، ووجه curl في عنوان URL الأساسي، ويعيد كل وحدة ومورد وحقل قابل للبحث يمكن لهذا المفتاح الوصول إليه.

إنشاء مفتاح API