We're always looking to make our integration API as accessible and easy to understand as possible for developers.
To date this has been achieved by having detailed documentation on each API endpoint and option, but today we've released a new way to discover and understand our APIs - introducing the API Explorer!
You can access the API Explorer right now on:
If you are using a branded website, simply tack "/apiexplorer" onto your custom domain name to access it.
About the API Explorer
Built on the awesome Swagger open source library, we've exposed all our current version 2 API endpoints in an easy to understand visual format.
Browse each available endpoint and its supported HTTP verbs, view the model properties and even test out calls to the API right there in the API Explorer.
Simply put its a integrators dream and we think it should make API integration projects that much easier to implement.
While the primary focus of the Explorer is on JSON format requests and responses, there are areas where you can specify an XML response type to get an idea of what the API requires and responds with on the XML side too.
The API Explorer is a dynamic, living document of our new version 2 API and is generated directly from our API code, thus allowing you to have confidence that what you see in the Explorer is exactly what is supported and available right now on the API.