文档与 API
为您的开发者准备的技术文档。
集成指南、REST API 与 webhook，助您将 Apus Platform 与您的系统对接。
文档目录
Base URL
https://api.apusplatform.com/v1API 参考文档以英文维护。
指南
IntroductionThe Apus Platform API is a REST API that lets external systems read and write your operational data — products, inventory, orders, production, partners, invoices, people, quality, assets and documents — over a single data layer. A write in one module is immediately visible to every other module.QuickstartMake your first call in three steps: (1) create an API client in the Account Console to get a client_id and client_secret; (2) exchange them for a short-lived access token; (3) call any endpoint with that token as a Bearer credential.AuthenticationThe API uses OAuth 2.0 client credentials. Create an API client in the Account Console to get a client_id and client_secret, then exchange them for a short-lived access token. Each client is granted a set of scopes (for example products:read, inventory:write) — an endpoint returns 403 if its scope is missing.PaginationList endpoints return up to 50 items by default (max 200 via limit). Responses are cursor-paginated: use the has_more flag and next_cursor to page forward. Cursors are opaque — pass them back unchanged.ErrorsThe API uses conventional HTTP status codes: 2xx success, 4xx for client errors (bad input, auth, not found), 5xx for server errors. Errors return a JSON body with a machine-readable code, a human message, the offending field where relevant, and a request_id to quote in support tickets.Rate limitsRequests are rate-limited per API client. The current limit is 120 requests per minute for reads and 60 per minute for writes; on-premise and source-code deployments can raise these.IdempotencyWrite requests (POST) accept an Idempotency-Key header. Reuse the same key to safely retry a request without creating duplicates — the API returns the original result for a repeated key within 24 hours.VersioningThe API is versioned in the path (/v1). Backwards-compatible changes — new endpoints, new optional fields, new enum values — ship without a version bump, so write clients that ignore unknown fields.
API 参考
Master data
Products10 endpointsThe product catalog — items you buy, make, stock or sell — plus categories, units of measure and price lists. Master data shared by inventory, sales, purchasing and finance. Keep an external PIM or POS in sync with these endpoints.Partners9 endpointsBusiness partners — the customers, suppliers and other counterparties your organization trades with — plus their contacts and addresses. Master data shared by sales, purchasing, distribution, finance and CRM. Sync a CRM, an e-invoice provider or an external directory against these endpoints.
Core operations
Inventory14 endpointsReal-time stock — on-hand, reserved and available quantities by SKU and warehouse — plus the warehouses, bins, lots, serials, adjustments, transfers and reservations that move it. The operational balance-sheet inventory that sales, purchasing and manufacturing draw down and replenish. Every mutation is an auditable event.Purchasing12 endpointsProcure-to-pay: requisitions, RFQs, purchase orders, goods receipts and supplier invoices. Orders you place with suppliers and the receiving status against them. Drive procurement from an external system, or read receiving and matching status for AP automation.Manufacturing (MES)13 endpointsShop-floor execution — production orders, work centers with live OEE, bills of materials, routings, completion and scrap reporting. The MES endpoints drive and observe what happens on the line: release an order, report finished quantity, log downtime, and read equipment effectiveness in real time.Finance & Accounting16 endpointsAccounts receivable and payable, payments, the general ledger and the closing cycle — invoices, journal entries, the chart of accounts, cost centers, fiscal periods, tax codes and exchange rates. The system of record for money owed and money owing. Feed an e-invoice provider, a bank reconciliation tool or an external BI warehouse from these endpoints.
People & Projects
Sales & CRM · orders7 endpointsThe sell side, end to end — sales orders and their fulfilment plus the CRM pipeline that feeds them: leads, opportunities and quotations. A confirmed order reserves stock and hands off to distribution and finance; a converted quotation or lead flows straight into an order. Sync a CRM, an e-commerce front end or an order-management system against these endpoints.Sales & CRM · crm8 endpointsThe sell side, end to end — sales orders and their fulfilment plus the CRM pipeline that feeds them: leads, opportunities and quotations. A confirmed order reserves stock and hands off to distribution and finance; a converted quotation or lead flows straight into an order. Sync a CRM, an e-commerce front end or an order-management system against these endpoints.Distribution (DMS)13 endpointsChannel distribution (DMS) — distributors and their territories, delivery routes and drivers, deliveries to the trade, field-sales visits and trade promotions. Use these endpoints to sync a mobile field-force app, plan daily routes and push orders down the channel.HRM14 endpointsHuman resources — the employee master, org structure, attendance, leave and payroll runs. People data shared by projects, timesheets, expenses and finance. Sync an HRIS, a time clock or a payroll provider against these endpoints.BI & Analytics11 endpointsRead-only analytics over your ERP data — datasets, ad-hoc queries, KPIs, dashboards, reports and exports. Query modelled facts and dimensions, pull KPI values for an external scorecard, or schedule a data export to a warehouse. Every endpoint reads data; none mutates it, so they all require the bi:read scope.
Quality & Knowledge
QMS – Quality13 endpointsQuality management — inspections, non-conformances (NCR), corrective and preventive actions (CAPA), checklists, standards and certificates. Records that gate incoming goods, in-process work and finished output, and prove compliance to auditors and customers. Feed a LIMS, an SPC tool or a supplier scorecard from these endpoints.Maintenance (EAM)13 endpointsEnterprise asset management: the equipment register, corrective and preventive work orders, meter readings, spare parts and recurring maintenance schedules. The physical assets you run and the maintenance history against them. Feed readings from IoT/SCADA, or drive work orders from an external CMMS.EDM – Documents13 endpointsElectronic document management — files, folders, versions and approval workflows. Store contracts, drawings, SOPs and certificates against a folder tree, route them for sign-off, and keep an auditable version history. Reference documents from any business object (an order, a work order, a supplier) via the reference field, and control access with per-document permissions.