Getting started

Get Access to API

Authentication

Making your first request

Guides

Generate Doc X-Ray

Generate Bank X-Ray

Generate Financial X-Ray

Generate ESG X-Ray

Generate Manager X-Ray

Concepts

Overview

Request

Reports

Medium

Doc X-Ray

Bank X-Ray

Financial X-Ray

ESG X-Ray

Manager X-Ray

Resources

API versioning

Webhooks

Uploading a media

API versioning

The October API is versioned. Our API versions are named for the date the version is released. For example, our latest version is 2024-01-25.

You set the version by including a October-Version header. Setting the October-Version header in required.

curl <https://api.october.eu/request/6464ba07cbddbd090b267260>
  -H "October-Version: 2024-01-25"
  ****-H "userId: abcd1234"
  -H "sessionToken: xyz789"

A new API version is released when we introduce a backwards-incompatible change to the API. This should insure that your integration will continue working for the foreseeable future.

<aside> 🚧

Required Header

The October-Version header must be included in all REST API requests. This ensures the October API response is consistent with what your code expects.

The most recent October-Version is "2024-01-25".

</aside>

<aside> 📘 Versioning is only for backwards incompatible changes

For new features and additions to the API, such as adding a new API endpoint, or including a new object in an existing API endpoint's response, there won't be a new version. You'll be able to take advantage of any new functionality on the version of the API you're currently using.

</aside>

← Previous

Concepts: Manager X-Ray

Next →

Resources: Webhooks