Olyn API Introduction

An interactive documentation to learn about Olyn API features and how to use them.


BETA stage

Olyn API is currently under stage Beta, be aware that Olyn API behaviour can change.
Check Change Log for up-to-date changes in each API version.

The Olyn API is organized around REST. Our API has predictable resource-oriented URLs, accepts application/json request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

You can use the Olyn API in sandbox mode, which doesn't affect your live data or interact with any external service which can infer any extra costs. The API key you use to authenticate the request is a different one from sandbox mode and live mode, additionally to both modes are clearly separated by a different base URL.

The Olyn API differs for every account as we release new versions. Olyn API compromises to maintain some old versions to allow the developer to migrate their services to a newer API version.

Get API Keys

Learn how Olyn API authenticates requests