RestAPI

Inventory Pro includes an optional REST API that enables third-party integrations, reporting tools, and automation scripts to read and write data programmatically. The API is not enabled by default - it must be deployed and configured as a separate IIS application. Contact CISS Ltd. to enable it for your installation.

Quick Reference

Availability

The API is a separate application that is deployed alongside the Desktop application. It is not present in all installations. If your organization has not enabled it, all API endpoints will return 404 or connection errors.

When deployed, the API base URL follows this pattern:

https://<your_system>/api/v1

Interactive documentation (Swagger UI) is available at:

https://<your_system>/api/v1/swagger

The Swagger page lists all available endpoints, accepted parameters, and response schemas for your specific deployment. It is the authoritative reference for your installation’s version of the API.

Authentication

The API uses OAuth 2.0 client credentials. Before making any API request:

1. Request API credentials (client ID and client secret) from your system administrator or CISS Ltd.
2. POST to the /Token endpoint:
   • grant_type: client_credentials
   • client_id: your assigned client ID
   • client_secret: your assigned client secret
3. Use the returned bearer token in the Authorization header of all subsequent requests:

   Authorization: Bearer <token>

Unauthenticated requests return HTTP 401.

Endpoint Coverage

When deployed, the API provides endpoints across these resource groups:

For exact endpoint signatures, request/response formats, and current availability, consult the Swagger UI on your deployed instance.

Related Topics

• Admin Options - system-wide configuration
• User Management - managing accounts that may use API credentials