Understand when to use Servertastic API V2 or V3 and how the two versions can be used together.
Servertastic currently provides Version 2 (V2) and Version 3 (V3) API endpoints.
You do not need to choose a single API version for your entire integration. V2 and V3 endpoints can be used together within the same integration.
The API version is identified by the version number in the endpoint path:
/v2/...or:
/v3/...API V2
API V2 remains fully supported.
Existing integrations using V2 do not need to migrate to V3. V2 endpoints will continue to be available.
Where functionality is documented only under V2, continue to use the V2 endpoint.
The absence of a V3 equivalent in this documentation means that there is currently no supported V3 endpoint for that function.
Do not assume that a V2 endpoint can be converted to V3 simply by changing /v2/ to /v3/.
API V3
API V3 is being introduced progressively and will receive new functionality, additional product support and increased automation.
V3 endpoints are added to this API reference as they become available for customer use.
Some functionality may initially be available only in V3, while other functionality will continue to use V2.
Using V2 and V3 together
V2 and V3 are designed to be used alongside each other.
A single integration may therefore use V2 for functionality currently provided by V2 and V3 for functionality available through V3.
There is no requirement to migrate an entire integration from V2 to V3 in order to use a V3 endpoint.
As additional V3 endpoints are released, they will be added to this API reference.
When a V3 equivalent becomes available
Where a V3 endpoint provides equivalent or enhanced functionality to an existing V2 endpoint, both versions may remain documented.
The V2 endpoint will continue to be identified as supported unless Servertastic explicitly announces a change to its support status.
If there is no documented V3 endpoint for the function you require, use the documented V2 endpoint.