جهات الاتصال
2العملاء، الموردون، والقطاعات التي ينتمون إليها.
جهات الاتصالشرائح جهات الاتصالتمنحك معظم برامج الأعمال واجهة برمجة تطبيقات (API) لكل منتج — واحدة لنقطة البيع، وأخرى للمخزون، وثالثة للفواتير، ولكل منها مصادقتها الخاصة وفهمها الخاص للتاريخ. Kardopal لديها واحدة. نفس المفتاح، ونفس عنوان URL الأساسي، ونفس قواعد الاستعلام تصل إلى 129 موردًا عبر 29 وحدة.
ستة أمور صحيحة هنا وعادة ما لا تكون كذلك.
اضرب عنوان 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=… — وكل منها يعلن عن هذه الخصائص. كل استجابة قائمة تحمل الإجمالي و يوجد المزيد، لذا فإن التصفح دورة، وليس تخميناً.
29 وحدة، 129 موردًا. كل بطاقة هي إذن واحد يمكنك منحه لمفتاح — والعلامة الرمادية هي حيث توجد نفس السجلات في التطبيق على هاتفك.
العملاء، الموردون، والقطاعات التي ينتمون إليها.
جهات الاتصالشرائح جهات الاتصالالكتالوج: المنتجات، المتغيرات، العلامات التجارية، قوائم الأسعار والوحدات.
العناصرالفئاتعلامات تجاريةمتغيرات الأصنافقوائم الأسعاروحدات+1 المزيدالمستودعات، مستويات المخزون، التحركات، الدفعات، الأرقام التسلسلية، والمواقع التخزينية.
المستودعاتحركات المخزونمستويات المخزوندفعاتالأرقام التسلسليةجرد-المخزون+1 المزيدالفواتير، التقديرات، الطلبات، إشعارات الائتمان، والمدفوعات.
الفواتيرتقديراتطلبات المبيعاتإشعارات دائنةالمدفوعاتفواتير متكررة+1 المزيدصناديق البيع، الورديات، الإيصالات، الطاولات وكل عملية بيع تمت عبر الكاونتر.
مبيعات نقاط البيعورديات نقاط البيعأجهزة نقاط البيعمستخدمو نقاط البيعطاولات POSمناطق-طاولات-POS+5 المزيدالعملاء المحتملون، الصفقات، مسارات المبيعات والمقترحات.
العملاء المحتملونالصفقاتمسارات العملمقترحاتأوامر الشراء، الطلبات، المرتجعات، الفواتير، ومدفوعات الموردين.
أوامر الشراءطلبات الشراءمرتجعات-المشترياتالفواتيرمدفوعات-الموردينالمصروفات، الحسابات المصرفية، المعاملات، ومعدلات الضرائب.
المصروفاتفئات المصروفاتالحسابات-المصرفيةbank-transactionsأسعار الضرائبحملات، مستلمون، صفحات هبوط، وتقديمات نماذج.
حملاتمستلمو-الحملاتالصفحات المقصودةإرسالات النماذجالموظفون، الأقسام، الإجازات، كشوف الرواتب، الحضور والتوظيف.
الموظفونالأقسامleave-requestsكشوف الرواتبالحضورإعلانات الوظائف+2 المزيدإدخالات الوقت والمشاريع التي تُسجل عليها.
إدخالات الوقتمشاريع جدول الدواممشاريع، مراحل، والتكاليف المرتبطة بها.
المشاريعمراحل المشروعتكاليف المشاريعالمواعيد، الخدمات القابلة للحجز والموظفون الذين يقدمونها.
الحجوزاتخدمات الحجزحجز-الموظفينالوظائف، الفنيون، أوامر العمل، العقود والمعدات.
مهام ميدانيةالفنيونطلبات الخدمةعقود الخدمةأوامر العملبطاقات العمل+1 المزيدالشحنات، السائقون، المركبات، المناطق، وشركات النقل.
شحناتالسائقونالمركباتمناطق التوصيلشركات الشحنالتذاكر، سياسات اتفاقية مستوى الخدمة، مقالات المساعدة، وقاعدة المعرفة.
تذاكرتذاكر العملاءمقالات المساعدةقاعدة المعرفةسياسات اتفاقية مستوى الخدمةالمرتجعات، مطالبات الضمان، الإصلاحات، وتسجيل المنتجات.
rmasمطالبات الضمانتسجيلات الضمانإصلاحاتتسجيلات المنتجاتالأصول القابلة للتأجير، اتفاقيات الإيجار وبنودها.
الأصولالإيجاراتبنود الإيجارقائمة الطعام والطلبات المقدمة عليها.
عناصر القائمةطلبات القائمةالتذاكر، الخدمات، العدادات، الفروع وشاشات العرض.
تذاكر الانتظارخدمات الانتظارعدادات الانتظارفروع قائمة الانتظارشاشات الانتظارالأعضاء، الحسابات، المستويات، المكافآت ومعاملات النقاط.
loyalty-membersحسابات الولاءمكافآت الولاءمستويات الولاءمعاملات الولاءloyalty-couponsالمواقع والفروع.
المواقعالفروعالأجهزة، المواقع، الصناديق، التنبيهات، الأحداث، ومحتوى اللافتات.
أجهزة إنترنت الأشياءiot-sitesتنبيهات IoTأحداث إنترنت الأشياءصناديق إنترنت الأشياءمحتوى-لافتات-إنترنت-الأشياءالأصول المُنشأة، المشاريع التي تحتويها، وسجل المهام.
أصول الذكاء الاصطناعيمشاريع الذكاء الاصطناعيوظائف الذكاء الاصطناعيأعضاء الشبكة، طلبات عروض الأسعار، والتحصيلات.
أعضاء الشبكةطلبات عروض الأسعارالمجموعاتطلبات التوقيع والتوقيعات التي تم جمعها مقابلها.
طلبات التوقيعالتوقيعاتطلبات الموافقة والقواعد التي توجهها.
طلبات-الموافقةقواعد الموافقةالملفات المرفوعة والمستندات الممسوحة ضوئيًا.
الملفاتالمستندات الممسوحة ضوئيًاسجل النشاط، سجل التدقيق، والإشعارات.
الأنشطةسجلات التدقيقإشعاراتهذا هو الجزء الذي عادة ما يكون غير صحيح. الكثير من المنصات توفر واجهة برمجة تطبيقات (API) واسعة ثم تقدم تطبيق جوال يقوم بثلاثة أشياء — الموافقة، العرض، الإشعار. تطبيق Kardopal هو المنتج، وليس مجرد رفيق: جميع الوحدات الـ29 المذكورة أعلاه لها شاشات حقيقية، والهاتف هو المكان الذي يحدث فيه معظم العمل فعليًا.
العناصر. لا يحتاج إلى hr. المفاتيح الضيقة آمنة في حالة الفشل.X-API-Key: kp_live_… — سلاسل الاستعلام تنتهي في السجلات، الخوادم الوكيلة (البروكسيات) وسجل المتصفح.توثق واجهة برمجة التطبيقات نفسها: أنشئ مفتاحًا في التطبيق، ووجه curl في عنوان URL الأساسي، ويعيد كل وحدة ومورد وحقل قابل للبحث يمكن لهذا المفتاح الوصول إليه.