Welcome

Greetings! Welcome to the ProSpend Open API Hub. Here, here you'll discover documentation and guides required to use our Open API platform.

Architecture

Our API is built on a RESTful architecture, adhering to industry standards and best practice API design. All APIs are stateless and use standard HTTP methods: GET, POST, PUT, and DELETE.  

HATEOAS won't be available in beta version but is planned to be introduced in General Release. JSON is the only supported data format, it is not expected that support for XML or other data formats will be supported.

Security

Access to the API Platform is managed using JWT (JSON Web Token) security. For more details, see the Authentication section.

Base URL

https://api.apac.prospend.io

Version

The API platform only supports URI versioning. e.g., https://api.apac.prospend.io/beta.

Limitations

The platform includes built-in rate-limiting mechanisms, which are currently switched off for beta but will be enabled in General Release. Monthly rate limits are determined by your subscription and hourly limits are set on fair usage capacity.

Standards

Date fields are in ISO 8601 format with UTC offset (e.g. 2023-11-06T20:18:31Z). Currencies are defined in ISO 4217 three-letter currency codes (e.g., AUD). Countries are in ISO 3166-1 alpha-2 codes (e.g., AU).