Welcome to the developer center for the Gotransverse JSON REST API.
To view documentation for previous Gotransverse APIs, see the XML SOAP API and XML REST API Developer Center.
API 2.0 Frequently Asked Questions
What is our overall API strategy?
Gotransverse aims to provide tenant-accessible APIs for all functionality available in our user interface. We also aim to balance the performance and granularity of the API requests with control over filtering and expanding the data returned through API requests using per-API-call parameter configurations. We provide backward-compatible APIs that continue to work release over the release and during our release upgrade process.
What does it mean when an API item is marked as
deprecated in API 2.0?
In Gotransverse, when an API item is marked as deprecated, we encourage you to use the provided alternatives because deprecated items are candidates for removal in the next API version. The deprecated items will continue to be supported in the current API version. In some cases, the deprecated item must not be used if an associated feature is desired. Contact the GTV Support team for more information.
What is our backward compatibility statement for API 2.0?
The Gotransverse API is built to work with a specified version of the Gotransverse billing platform.
Gotransverse considers the following types of changes to be backward compatible:
- Adding new API resources: new paths, optional query parameters, and optional fields in existing payloads in published API versions. Client applications should ignore unknown fields.
- Changing the order of fields in existing payloads.
- Making a required field optional.
- Modifying the text of an error message, but not the HTTP response code.
- Marking an API as deprecated to discourage use in future versions.
- Fixing defects that are determined to be incorrect behavior.
- Changing the OpenAPI/Swagger model metadata such as names and operation IDs. The underlying payload, fields, query parameters, and paths will not change for a published version.