Getting started
Get Access to APIAuthenticationMaking your first requestGuides
Generate Doc X-RayGenerate Bank X-RayGenerate Financial X-RayGenerate ESG X-RayGenerate Manager X-RayConcepts
OverviewRequestReportsMediumDoc X-RayBank X-RayFinancial X-RayESG X-RayManager X-RayResources
API versioningWebhooksUploading a mediaAdd a creator to your requestTesting environmentOrganization & MembersSecuritySupportAuthentication
Introduction
The October Connect API utilises API keys to authenticate requests.
In particular, authentication to the API is performed via the HTTP request headers.
In order to perform an authenticated API call, you must set the following three parameters in the header of your HTTP request:
userId
: ID of the user that is making the requestsessionToken
: API keyOctober-Version
: See current API version on API versioning page
In this page, we guide you through getting an October API key and making your first authentication request.
Getting API Keys
- Sign in to your October account using our WebApp.
- Click on the “Edit your profile” in the user menu, then “API token” section
- If you do not see the “API Token” section, please contact your October account manager.
- Click on the “New token” button
- Add a description for the token (e.g: “My API integration”) and confirm.
- You will then see a Session Token, as well as your User ID.
- Use those to communicate with the API
API Key for programmatic API calls
To perform an authenticated API call programmatically, you must set the following header information:
userId: <YOUR-USER-ID>
sessionToken: <YOUR-API-TOKEN>
October-Version: <LATEST-OCTOBER-API-VERSION>
You will find bellow an example of http request using curl
:
curl https://api.october.eu/requests
-H "October-Version: 2023-06-01"
-H "userId: <YOUR-USER-ID>"
-H "sessionToken: <YOUR-API-TOKEN>"
IMPORTANT
All requests that are sent to October API should only be done using HTTPS. Indeed, all API calls that do not have the header structure shown above will be rejected with the HTTP error code: 401
Well done! You should now be able to integrate with our API.
Keep API keys and User ID secure!
IMPORTANT
The API key and
userId
provided to you carry your all the privileges given to you by October, so keep them secure! It is important that you do not share those informations in publicly accessible areas.