Introduction
Introduction to the ProSpend Open API Portal
Early Access Program
The current version of the ProSpend API is being released as part of an Early Access Program (EAP) for a select group of customers. The EAP program is a pre-beta release of the software platform and as such may have incomplete features, have unforeseen issues that could impact its stability and functionality. By accessing the pre-beta version, EAP customers acknowledge and accept the risks associated with its use.
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. Tokens are issued by ProSpend to EAP participants directly.
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, these are currently switched off for EAP but will become 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 ISO8601 format with UTC offset (e.g. 2023-11-06T20:18:31Z), currencies are defined in ISO 4217 three-digit numeric currency codes (e.g. AUD), and Countries are in ISO 3166-1 alpha-2 codes (e.g. AU).
Sandbox
A full sandbox environment will be available through https://sandbox.prospend.io