Overview
- The Stax Bill API is organized around REST.
- The API has predictable, resource-oriented URLs and uses HTTP response codes to indicate API errors.
- It uses built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients.
- Some calls support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website's client-side code).
- JSON is returned by all API responses, including errors.
Stax Bill Sandbox Account
Before you do anything, you should work with your implementation specialist to get a sandbox account. One will be used during the initial implementation process, so a member of your team should already have access to it.
Example Requests
Sample API calls are provided next to each method using cURL, a common command line tool for performing HTTP requests. All you need to do is drop in your specific parameters, and you can test the calls from the command line. If the command line isn’t your preference, a great alternative is POSTMAN, an easy-to-use tool for working with a REST API. Additionally, there are usage examples in C# and Python, and sample JSON payloads where relevant.
Sample workflows and tutorials walking you through common use cases and best practices are also available.
Stax Bill uses the Stax Bill API
To ensure our API serves the needs of our customers and is a pleasure for developers to use, the development team at Stax Bill builds all of our account and customer-facing applications using the Stax Bill API.
We want to ensure our API has a stable interface and performs well under the stresses of real-world use. To ensure we provide the best possible solutions to integrators, we first launch features against a private API resource. As we become confident in the interface and performance stability of these new resources, they may be made available through the Stax Bill API.