Versioning

Overview

The Yoco API version number is specified in the URL when making an HTTP request.

Here is an example of a request to the v1 API end-point for retrieving a list of orders.

1
from yoco_demo import Yoco
2
3
client = Yoco()
4
client.orders.search()

We will never introduce breaking changes to an existing API version. We will always increment the version number of the API.

What is a non-breaking change?

• Adding a new API resource.
• Adding a new API end-point.
• Adding a new optional request parameter to an existing API method.
• Adding a new property to an existing API response.
• Changing the order of properties in an existing API response.

What is a breaking change?

• Removing an API resource.
• Removing an API end-point.
• Removing a request parameter from an API method.
• Changing the behaviour of a request parameter on an API method.
• Adding a new required request parameter to an API method.
• Renaming or re-shaping an API resource, end-point, request parameter or response property.
• Change to the HTTP status code returned from an operation.