Skip to main content

4. API Reference

Where to find the interactive API reference​

The interactive API reference is available in the API (Swagger) tab of this documentation (top navigation). Open Swagger UI →

It documents every endpoint, request schema, response shape, and error code needed to integrate with OneConnect by Shine.

Worked request examples (purchase invoice, sales invoice, and accounting entries, including analytic axes) are listed on each of those operations in Swagger, and in Using the API — Complete examples.