Danh bạ
2Khách hàng, nhà cung cấp và các phân khúc mà họ thuộc về.
liên hệphân khúc liên hệHầu hết phần mềm kinh doanh cung cấp cho bạn một API cho mỗi sản phẩm — một cho quầy thu ngân, một cho kho hàng, một cho hóa đơn, mỗi API có xác thực riêng và cách hiểu riêng về ngày tháng. Kardopal chỉ có một. Cùng một khóa, cùng một URL cơ sở và cùng một ngữ pháp truy vấn có thể truy cập 129 tài nguyên trên 29 mô-đun.
Sáu điều đúng ở đây nhưng thường không đúng ở nơi khác.
Truy cập URL cơ sở và API sẽ trả về danh mục của chính nó — mọi mô-đun mà khóa của bạn có thể thấy, mọi tài nguyên bên trong nó, trường nào có thể tìm kiếm và trường nào có thể lọc. Bạn không cần trang này để viết tích hợp; bạn cần nó để đưa ra quyết định.
Các phạm vi, tuyến đường và quyền trong ứng dụng được tạo từ một danh sách, vì vậy một quyền không thể được cấp trừ khi có một điểm cuối hỗ trợ nó. Một khóa được giới hạn cho mặt hàng lấy các mục — yêu cầu nó về bảng lương sẽ trả về lỗi 403, chứ không phải một trang trống không báo lỗi.
tìm kiếm, từ, cho đến khi, bỏ qua và lấy có ý nghĩa giống nhau trên hóa đơn và trên các giao dịch kho. Chỉ cần học một lần và tất cả 133 tài nguyên đều tuân theo.
Mỗi bảng đều có ID người thuê và mọi truy vấn đều được giới hạn trong người thuê của khóa trước khi đến cơ sở dữ liệu. Không có thao tác đọc chéo người thuê nào có thể sai, vì không có tham số nào có thể yêu cầu điều đó.
Danh sách trường được đọc từ lược đồ trực tiếp khi khởi động thay vì được duy trì thủ công. Một cột mới sẽ tự động hiển thị; một cột bị loại bỏ sẽ không bao giờ để lại tham chiếu lơ lửng trong tài liệu hoặc lỗi 500 khi gọi lần đầu.
Khóa chỉ đọc; không bao giờ ghi. Một tích hợp bị lỗi không thể hủy hóa đơn hoặc di chuyển hàng tồn kho. Bất cứ điều gì thay đổi một bản ghi đều phải thông qua ứng dụng hoặc đăng nhập của nhân viên, nơi nó được gán cho một người và ghi vào nhật ký kiểm toán.
Mọi thứ đều là GET. Nếu bạn có thể sử dụng curl, bạn có thể sử dụng cái này.
/api/v1Toàn bộ danh mục mà khóa của bạn có thể xemcurl https://api.kardopal.com/api/v1 \
-H "X-API-Key: kp_live_…"
/api/v1/meKiểm tra tính hợp lệ — đây là khóa của ai, và nó có thể đọc những gì{
"authType": "api_key",
"tenant": { "name": "Nova Retail", "plan": "pro" },
"scopes": ["items", "sales", "pos"]
}
/api/v1/items?search=lamp&take=2Mọi tài nguyên, cùng một định dạng{
"resource": "items",
"scope": "items",
"total": 41,
"skip": 0,
"take": 2,
"hasMore": true,
"data": [ { "id": "…", "name": "Desk Lamp LED" } ]
}
/api/v1/meta/countsSố lượng hàng trên mỗi tài nguyên — xem dữ liệu nào thực sự tồn tại.curl https://api.kardopal.com/api/v1/meta/counts \
-H "X-API-Key: kp_live_…"
| Tham số | Thực hiện | Ghi chú |
|---|---|---|
tìm kiếm | Khớp không phân biệt chữ hoa chữ thường trên các trường có thể tìm kiếm của tài nguyên. | Các trường đó được liệt kê trong /meta |
từ | Chỉ các bản ghi từ ngày này trở đi | Áp dụng cho trường mà tài nguyên sắp xếp theo |
cho đến khi | Chỉ ghi nhận đến ngày này | Kết hợp với từ cho một cửa sổ |
bỏ qua | Bù đắp vào tập kết quả. | Mặc định là 0 |
lấy | Số dòng trả về | Mặc định là 50, tối đa 200 |
Các tài nguyên cũng chấp nhận bộ lọc khớp chính xác trên các trường được khai báo của riêng chúng — ?status=paid, ?warehouseId=… — và mỗi cái đều quảng cáo những cái đó là gì. Mọi phản hồi danh sách đều mang theo tổng cộng và có thêm, để phân trang là một vòng lặp, không phải một phỏng đoán.
29 mô-đun, 129 tài nguyên. Mỗi thẻ là một quyền bạn có thể cấp cho một khóa — và thẻ màu xám là nơi các bản ghi tương tự nằm trong ứng dụng trên điện thoại của bạn.
Khách hàng, nhà cung cấp và các phân khúc mà họ thuộc về.
liên hệphân khúc liên hệDanh mục: sản phẩm, biến thể, thương hiệu, bảng giá và đơn vị.
mặt hàngdanh mụcthương hiệubiến thể mặt hàngprice-listsđơn vị+1 nữaKho hàng, mức tồn kho, di chuyển hàng hóa, lô hàng, số sê-ri và vị trí lưu trữ.
kho hàngstock-movementsmức tồn khobatchessố sê-rikiểm kê kho+1 nữaHóa đơn, báo giá, đơn hàng, phiếu ghi nợ và thanh toán.
hóa đơnước tínhđơn hàng bánphiếu ghi nợthanh toánhóa đơn định kỳ+1 nữaMáy tính tiền, ca làm việc, biên lai, bàn và mọi giao dịch bán hàng qua quầy.
doanh số POSca-làm-việc-posthiết bị POSngười dùng POSbàn POSkhu vực bàn POS+5 nữaKhách hàng tiềm năng, giao dịch, quy trình và đề xuất.
khách hàng tiềm nănggiao dịchquy trìnhđề xuấtĐơn đặt hàng, yêu cầu, trả hàng, hóa đơn và thanh toán nhà cung cấp.
đơn đặt hàngyêu cầu mua hàngTrả hàng muahóa đơnThanh toán cho nhà cung cấpChi phí, tài khoản ngân hàng, giao dịch và thuế suất.
chi phídanh mục chi phítài khoản ngân hàngbank-transactionsmức thuếChiến dịch, người nhận, trang đích và biểu mẫu đã gửi.
chiến dịchngười nhận chiến dịchtrang đíchđơn đã gửiNhân sự, phòng ban, nghỉ phép, phiếu lương, chấm công và tuyển dụng.
nhân viênphòng banleave-requestsphiếu lươngĐiểm danhtin tuyển dụng+2 nữaNhật ký thời gian và các dự án được ghi nhận.
ghi nhận thời giandự án bảng chấm côngDự án, các giai đoạn và chi phí liên quan.
Dự ánproject-phaseschi phí dự ánLịch hẹn, dịch vụ có thể đặt trước và nhân viên thực hiện.
đặt lịchdịch vụ đặt lịchđặt lịch nhân viênCông việc, kỹ thuật viên, lệnh làm việc, hợp đồng và thiết bị.
công việc hiện trườngkỹ thuật viênyêu cầu dịch vụhợp đồng dịch vụlệnh sản xuấtphiếu công việc+1 nữaLô hàng, tài xế, phương tiện, khu vực và nhà vận chuyển.
lô hàngtài xếphương tiệnkhu vực giao hàngnhà vận chuyểnPhiếu, chính sách SLA, bài viết trợ giúp và cơ sở tri thức.
phiếuphiếu yêu cầu của khách hàngbài viết trợ giúpcơ sở tri thứcchính-sách-slaTrả hàng, yêu cầu bảo hành, sửa chữa và đăng ký sản phẩm.
rmasyêu cầu bảo hànhwarranty-registrationssửa chữađăng ký sản phẩmTài sản cho thuê, hợp đồng thuê và các hạng mục liên quan.
tài sảncho thuêdòng thuêThực đơn và các đơn hàng được đặt theo đó.
mục thực đơnđơn hàng thực đơnPhiếu, dịch vụ, quầy, chi nhánh và màn hình hiển thị.
queue-ticketsdịch vụ xếp hàngbộ đếm hàng đợichi nhánh xếp hàngmàn hình hiển thị hàng đợiThành viên, tài khoản, cấp độ, phần thưởng và giao dịch điểm.
loyalty-memberstài khoản khách hàng thân thiếtphần thưởng khách hàng thân thiếtcác cấp độ khách hàng thân thiếtgiao dịch khách hàng thân thiếtloyalty-couponsĐịa điểm và chi nhánh.
địa điểmchi nhánhThiết bị, địa điểm, hộp, cảnh báo, sự kiện và nội dung biển báo.
thiết bị IoTiot-sitescảnh báo IoTsự kiện IoTiot-boxesnội dung biển báo IoTTài sản đã tạo, các dự án chứa chúng và lịch sử công việc.
tài sản AIdự án AIai-jobsThành viên mạng lưới, yêu cầu báo giá và thu nợ.
thành viên mạng lướiyêu cầu báo giábộ sưu tậpYêu cầu chữ ký và các chữ ký đã thu thập được.
yêu cầu chữ kýchữ kýYêu cầu phê duyệt và các quy tắc định tuyến chúng.
yêu cầu phê duyệtquy tắc phê duyệtTệp đã tải lên và tài liệu đã quét.
tệp tinscanned-documentsBảng tin hoạt động, nhật ký kiểm toán và thông báo.
hoạt độngnhật ký kiểm toánthông báoĐây là phần thường không đúng sự thật. Nhiều nền tảng cung cấp API rộng rãi nhưng sau đó chỉ phát hành ứng dụng di động làm ba việc — phê duyệt, xem, thông báo. Ứng dụng của Kardopal là sản phẩm chính, không phải là một ứng dụng phụ trợ: tất cả 29 mô-đun trên đều có giao diện thực tế, và điện thoại là nơi hầu hết công việc được thực hiện.
mặt hàng. Nó không cần hr. Các khóa hẹp an toàn khi lỗi.X-API-Key: kp_live_… — chuỗi truy vấn kết thúc trong nhật ký, proxy và lịch sử trình duyệt.API tự tài liệu hóa: tạo khóa trong ứng dụng, trỏ curl tại URL cơ sở, và nó trả về mọi mô-đun, tài nguyên và trường có thể tìm kiếm mà khóa đó có thể truy cập.