webapi-index

Guides K/3 Cloud WebAPI integration decisions, endpoints, authentication, and error handling.

24|7|Updated Apr 20, 2026
One-click install
npx skills add https://github.com/qiaolei227/opendeploy --skill webapi-index-qiaolei227
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: webapi-index
Source: https://github.com/qiaolei227/opendeploy/tree/main/knowledge/skills/k3cloud/webapi-index
Command: npx skills add https://github.com/qiaolei227/opendeploy --skill webapi-index-qiaolei227

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? When a client asks to integrate Kingdee K/3 Cloud with external systems (e-commerce, OA, BI, third-party platforms), consultants often guess endpoints, pick the wrong authentication method, or confuse WebAPI tasks with plugin tasks. This Skill provides a decision index for K/3 Cloud WebAPI integration so the agent gives correct guidance instead of hallucinated endpoints. ## Core Features & Use Cases - Boundary triage: Distinguishes whether a requirement should go through WebAPI, a server-side Python/DLL plugin, or a customer-built integration layer (ESB/iPaaS). - On-demand references: Four lazy-loaded reference files covering authentication (ValidateUser / LoginByAppSecret / signature), 12 common endpoints (ExecuteBillQuery, Save, BatchSave, Submit, Audit, Push, attachments), error handling (three-layer error model, throttling, retry strategy), and integration pattern selection (Pull / Push / Batch / Event). - Use Case: A client says "sync our Tmall orders into K/3 Cloud." The agent first classifies this as a Push pattern, then provides the Save/Submit/Audit endpoint templates, idempotency advice, and field-ordering pitfalls from the references. ## Quick Start Ask the agent how to connect an external system such as an e-commerce platform or OA to K/3 Cloud, and it will classify the integration pattern and load the relevant WebAPI reference.

Frequently Asked Questions about webapi-index

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I integrate K/3 Cloud with an external system like e-commerce or OA?▼

Use the K/3 Cloud WebAPI, the only recommended channel, exposed as HTTP plus JSON endpoints under /K3Cloud/. First classify the need as pull, push, batch, or event-driven, then select endpoints such as ExecuteBillQuery for queries or Save, Submit, and Audit for writes.

Which K/3 Cloud WebAPI login method should I use?▼

Use ValidateUser with account and password only for private deployments before V8.0. For V8.0+ and public cloud tenants, LoginByAppSecret with AppId and AppSecret is mandatory. A signature-based login exists for high-security scenarios.

Why does K/3 Cloud WebAPI return HTTP 200 but the operation failed?▼

K/3 Cloud does not signal business errors via HTTP status codes. The real success criterion is ResponseStatus.IsSuccess equals true; check Errors[].FieldName and Message for the cause, and MsgCode 1 means the session expired.

What are the batch limits for K/3 Cloud WebAPI BatchSave?▼

Kingdee officially recommends at most 20 records per BatchSave call, BatchCount of 10 or less (5 recommended), and 2-10 client threads. Exceeding these causes connection pool exhaustion and intermittent HTTP 500 errors.

When should I write a plugin instead of using K/3 Cloud WebAPI?▼

Use a server-side plugin when the requirement involves complex logic WebAPI cannot perform, such as custom validation, cross-document cascading, or post-approval cost and inventory calculations. WebAPI only triggers operations; heavy server-side logic belongs in plugins.

Can I write business data directly to K/3 Cloud database tables?▼

No. Direct SQL writes to business tables bypass BOS engine validation, approval flows, permissions, and plugins, causing data corruption and violating Kingdee license terms. All business data must flow through WebAPI endpoints.