API และเอกสารประกอบ

กุญแจเดียว ทุกโมดูล.

ซอฟต์แวร์ธุรกิจส่วนใหญ่ให้ API แยกตามผลิตภัณฑ์ — หนึ่งสำหรับเครื่องคิดเงิน อีกหนึ่งสำหรับสต็อก และอีกหนึ่งสำหรับใบแจ้งหนี้ โดยแต่ละรายการมีระบบยืนยันตัวตนและแนวคิดเกี่ยวกับวันที่เป็นของตัวเอง Kardopal มีเพียงหนึ่งเดียว คีย์เดียวกัน, URL พื้นฐานเดียวกัน และไวยากรณ์การสอบถามเดียวกัน สามารถเข้าถึง 129 ทรัพยากรใน 29 โมดูล

สร้างคีย์ API ดูว่ามันไปถึงไหน
29
โมดูล
129
ทรัพยากร
1
คีย์, URL พื้นฐานเดียว
200
จำนวนแถวสูงสุดต่อหน้า

ทำไม API นี้ถึงน่าลงทุนพัฒนา

หกสิ่งที่เป็นจริงที่นี่ แต่โดยทั่วไปแล้วไม่เป็นเช่นนั้น

อธิบายตัวเองได้

เรียกใช้ Base 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_…"

ห้าพารามิเตอร์

พารามิเตอร์ทำอะไรบ้างบันทึก
ค้นหาการจับคู่แบบไม่คำนึงถึงตัวพิมพ์เล็ก-ใหญ่ในทุกฟิลด์ที่ค้นหาได้ของทรัพยากรรายการฟิลด์เหล่านั้นระบุไว้ใน /เมตา
ตั้งแต่เฉพาะบันทึกตั้งแต่วันที่นี้เป็นต้นไปใช้กับฟิลด์ที่ทรัพยากรจัดเรียงตาม
จนถึงบันทึกเฉพาะข้อมูลถึงวันที่นี้รวมกับ ตั้งแต่ สำหรับหน้าต่าง
ข้ามชดเชยในชุดผลลัพธ์ค่าเริ่มต้นคือ 0
รับจำนวนแถวที่ต้องการแสดงค่าเริ่มต้น 50 สูงสุด 200

ทรัพยากรยังรองรับการกรองแบบตรงกันทุกประการในฟิลด์ที่ประกาศไว้ — ?status=paid, ?warehouseId=… — และแต่ละรายการจะโฆษณาว่ามีอะไรบ้าง การตอบกลับรายการทุกครั้งจะแสดง รวม และ มีเพิ่มเติมเพื่อให้การแบ่งหน้าเป็นวงจร ไม่ใช่การคาดเดา

สิ่งที่ API เข้าถึงได้

29 โมดูล 129 ทรัพยากร การ์ดแต่ละใบคือสิทธิ์ที่คุณสามารถมอบให้คีย์ได้ — และแท็กสีเทาคือที่ที่บันทึกเดียวกันนี้อยู่ในแอปบนโทรศัพท์ของคุณ

ผู้ติดต่อ

2

ลูกค้า ซัพพลายเออร์ และกลุ่มลูกค้า/ซัพพลายเออร์

ผู้ติดต่อกลุ่มเป้าหมายผู้ติดต่อ
ผู้ติดต่อ ผู้ติดต่อ

รายการสินค้า

7

แค็ตตาล็อก: สินค้า, รูปแบบสินค้า, แบรนด์, รายการราคา และหน่วย

รายการหมวดหมู่แบรนด์รายการสินค้าหลากหลายรายการราคาหน่วย+1 เพิ่มเติม
รายการ รายการสินค้า

คลังสินค้า

7

คลังสินค้า ระดับสต็อก การเคลื่อนย้ายสินค้า ล็อตสินค้า หมายเลขซีเรียล และที่เก็บสินค้า

คลังสินค้าstock-movementsระดับสต็อกสินค้าbatchesหมายเลขซีเรียลการนับสต็อก+1 เพิ่มเติม
inventory คลังสินค้า

การขาย

7

ใบแจ้งหนี้, ใบเสนอราคา, คำสั่งซื้อ, ใบลดหนี้ และการชำระเงิน

ใบแจ้งหนี้ใบเสนอราคาใบสั่งขายใบลดหนี้การชำระเงินใบแจ้งหนี้ที่เกิดซ้ำ+1 เพิ่มเติม
การขาย การขาย

POS

11

เครื่องคิดเงิน, กะทำงาน, ใบเสร็จ, โต๊ะ และทุกการขายที่ผ่านเคาน์เตอร์

ยอดขาย POSกะ POSpos-terminalsผู้ใช้ POSตาราง POSพื้นที่โต๊ะ POS+5 เพิ่มเติม
pos POS

CRM

4

ลูกค้าเป้าหมาย ข้อตกลง ขั้นตอนการขาย และข้อเสนอ

ลูกค้าเป้าหมายข้อเสนอกระบวนการขายข้อเสนอ
crm CRM

การจัดซื้อ

5

ใบสั่งซื้อ คำขอ การคืนสินค้า บิล และการชำระเงินให้ผู้ขาย

ใบสั่งซื้อคำขอจัดซื้อการคืนสินค้าที่ซื้อบิลการชำระเงินผู้ขาย
ซื้อ การจัดซื้อ

การบัญชี

5

ค่าใช้จ่าย บัญชีธนาคาร ธุรกรรม และอัตราภาษี

ค่าใช้จ่ายหมวดหมู่ค่าใช้จ่ายบัญชีธนาคารbank-transactionsอัตราภาษี
การบัญชี การบัญชี

การตลาด

4

แคมเปญ ผู้รับ หน้า Landing Page และการส่งแบบฟอร์ม

แคมเปญผู้รับแคมเปญหน้า Landing Pageการส่งแบบฟอร์ม
การตลาด การตลาด

HR

8

บุคลากร แผนก การลา สลิปเงินเดือน การเข้างาน และการจ้างงาน

พนักงานแผนกleave-requestsสลิปเงินเดือนการเข้างานตำแหน่งงานว่าง+2 เพิ่มเติม
hr HR

ตารางเวลาทำงาน

2

การบันทึกเวลาและโครงการที่เกี่ยวข้อง

บันทึกเวลาโครงการบันทึกเวลา
ใบบันทึกเวลา ตารางเวลาทำงาน

โครงการ

3

โครงการ ระยะ และค่าใช้จ่ายที่เกี่ยวข้อง

โครงการproject-phasesค่าใช้จ่ายโครงการ
โครงการ โครงการ

การจอง

3

การนัดหมาย, บริการที่จองได้ และพนักงานผู้ให้บริการ

การจองบริการจองจองพนักงาน
การจอง การจอง

บริการนอกสถานที่

7

งาน, ช่างเทคนิค, ใบสั่งงาน, สัญญา และอุปกรณ์

field-jobsช่างเทคนิคคำขอบริการสัญญาบริการใบสั่งงานใบงาน+1 เพิ่มเติม
บริการภาคสนาม บริการนอกสถานที่

โลจิสติกส์

5

การจัดส่ง พนักงานขับรถ ยานพาหนะ โซน และผู้ขนส่ง

การจัดส่งพนักงานขับรถยานพาหนะพื้นที่จัดส่งผู้ให้บริการขนส่ง
โลจิสติกส์ โลจิสติกส์

ฝ่ายช่วยเหลือ

5

ตั๋ว, นโยบาย SLA, บทความช่วยเหลือ และฐานข้อมูลความรู้

ตั๋วตั๋วลูกค้าบทความช่วยเหลือฐานข้อมูลความรู้นโยบาย SLA
การสนับสนุน ฝ่ายช่วยเหลือ

หลังการขาย

5

การคืนสินค้า การเคลมประกัน การซ่อมแซม และการลงทะเบียนผลิตภัณฑ์

RMAการเคลมประกันการลงทะเบียนการรับประกันการซ่อมแซมproduct-registrations
หลังการขาย หลังการขาย

การเช่า

3

ทรัพย์สินให้เช่า สัญญาเช่า และรายการในสัญญา

สินทรัพย์การเช่าrental-lines
การเช่า การเช่า

ร้านอาหาร

2

เมนูและคำสั่งซื้อที่เกี่ยวข้อง

menu-itemsคำสั่งเมนู
ร้านอาหาร อาหารและเครื่องดื่ม

คิว

5

ตั๋ว, บริการ, เคาน์เตอร์, สาขา และจอแสดงผล

บัตรคิวบริการจัดการคิวตัวนับคิวสาขาในคิวqueue-displays
คิว คิว

ความภักดี

6

สมาชิก, บัญชี, ระดับ, รางวัล และการทำธุรกรรมคะแนน

loyalty-membersบัญชีสะสมคะแนนรางวัลสะสมแต้มระดับความภักดีรายการสะสมแต้มloyalty-coupons
ความภักดี ความภักดี

สถานที่

2

สาขาและที่ตั้ง

สถานที่สาขา
สถานที่ สถานที่

IOT

6

อุปกรณ์, สถานที่, กล่อง, การแจ้งเตือน, กิจกรรม และเนื้อหาป้ายดิจิทัล

อุปกรณ์ IoTiot-sitesการแจ้งเตือน IoTเหตุการณ์ IoTกล่อง IoTเนื้อหาป้ายดิจิทัล IoT
iot IOT Hub

AI Studio

3

สินทรัพย์ที่สร้างขึ้น โปรเจกต์ที่เกี่ยวข้อง และประวัติงาน

ai-assetsโครงการ AIai-jobs
ai_studio AI Studio

การค้า

3

สมาชิกเครือข่าย คำขอใบเสนอราคา และการเก็บเงิน

สมาชิกเครือข่ายคำขอใบเสนอราคาคอลเลกชัน
การค้า การค้า

ลายเซ็นอิเล็กทรอนิกส์

2

คำขอลงนามและลายเซ็นที่รวบรวมไว้

คำขอลงนามลายเซ็น
ลายเซ็น ลายเซ็นอิเล็กทรอนิกส์

การอนุมัติ

2

คำขออนุมัติและกฎที่ใช้กำหนดเส้นทาง

คำขออนุมัติกฎการอนุมัติ
การอนุมัติ การอนุมัติ

ไฟล์

2

ไฟล์ที่อัปโหลดและเอกสารที่สแกน

ไฟล์เอกสารที่สแกน
ไฟล์ ไฟล์

กิจกรรม

3

ฟีดกิจกรรม, บันทึกการตรวจสอบ และการแจ้งเตือน

กิจกรรมบันทึกการตรวจสอบการแจ้งเตือน
ทางโทรศัพท์

ทุกโมดูลที่ API อ่าน ทีมของคุณสามารถเปิดดูได้ในมือ

นี่คือส่วนที่มักจะไม่เป็นความจริง แพลตฟอร์มจำนวนมากเปิดเผย API ที่กว้างขวาง จากนั้นก็ส่งแอปมือถือที่ทำได้สามอย่าง — อนุมัติ ดู แจ้งเตือน แอปของ Kardopal คือผลิตภัณฑ์ ไม่ใช่แค่แอปเสริม: โมดูลทั้ง 29 รายการข้างต้นมีหน้าจอจริง และโทรศัพท์คือที่ที่งานส่วนใหญ่เกิดขึ้นจริง

  • อ่านแล้วลงมือทำ ระบบของคุณดึงระดับสต็อกออกมา ผู้ที่ต้องแก้ไขจะเปิดบันทึกเดียวกัน ปรับเปลี่ยน และลงชื่อในชื่อของตน
  • สแกน, ถ่าย, เซ็น. การสแกนบาร์โค้ด, การจับภาพเอกสาร และลายเซ็นอิเล็กทรอนิกส์ถูกออกแบบมาสำหรับโทรศัพท์มือถือ — ไม่มีเวอร์ชันเดสก์ท็อปที่เทียบเท่าและคุ้มค่าที่จะใช้
  • ทำงานได้แม้ไม่มีอินเทอร์เน็ตที่เคาน์เตอร์ เครื่องคิดเงิน จอครัว และจอคิว ยังคงทำงานได้แม้การเชื่อมต่อไม่เสถียร
  • เข้าสู่ระบบเดียวกัน, ข้อมูลเดียวกัน, 20 ภาษา. รวมถึงภาษาที่อ่านจากขวาไปซ้าย เพื่อให้ทีมที่พูดภาษาอาหรับไม่ต้องอ่านเลย์เอาต์ที่กลับด้าน
ดูแพลตฟอร์ม
แอป Kardopal ที่ทำงานบนโทรศัพท์

การรับคีย์

เปิดแอป, ไปที่ Platform → API Keysคีย์ถูกสร้างโดยเจ้าของหรือผู้ดูแลระบบในบัญชีของคุณเอง ไม่มีใครที่ Kardopal ออกคีย์ให้คุณ
เลือกเฉพาะโมดูลที่จำเป็นสำหรับการเชื่อมต่อวิดเจ็ตหน้าร้านต้องการ รายการไม่จำเป็นต้องมี hr. คีย์ที่จำกัดจะทำงานอย่างปลอดภัย
ส่งเป็นส่วนหัว ห้ามส่งใน URLX-API-Key: kp_live_… — สตริงคำค้นหาจะถูกบันทึกในล็อก พร็อกซี และประวัติเบราว์เซอร์
หมุนเวียนโดยการสร้างคีย์ใหม่ก่อนทั้งสองทำงานพร้อมกัน คุณจึงสามารถย้ายทราฟฟิกและเพิกถอนอันเก่าได้โดยไม่มีช่วงเวลาหยุดทำงาน

สร้างสรรค์ต่อยอดได้

API มีเอกสารในตัว: สร้างคีย์ในแอป, ชี้ curl ที่ URL หลัก และจะส่งคืนทุกโมดูล ทรัพยากร และฟิลด์ที่ค้นหาได้ที่คีย์นั้นสามารถเข้าถึงได้

สร้างคีย์ API