Beam API clients
The recommended way to interact with the Beam API is by using one of our official clients.
At the time of writing, the clients we’re shipping are all automatically generated after every service release. We’re currently using OpenAPI generator and OpenAPI Typescript Codegen.
It’s of the utmost importance that your API key never gets exposed. If your API key is / has been at risk of being exposed, please contact build@onbeam.com. Alternatively: re-create your API keys yourself using the provided regenerate-key, the old ones will automatically be invalidated.
API clients
In order to get started, we currently provide the following clients. Note that if there’s no available client available for your preferred language, there’s always the possibility of directly connecting to the RESTful endpoints by passing your API key in the x-api-key header.
Automation API clients
All of the Automation API clients are meant to be used server side, as it’s crucial to not expose any of the api keys we provided publicly.
Player API clients
The Player API clients can be used in the client, as the API that is required to interact with the self-custody services can be exposed without risk.
Beam clients repository
If you’re interested in how we generate the clients, have a look at the Github repository. If you don’t want to use our provided clients, it might still be of inspiration.
Releases
If you are interested in more granular changelogs for SDK releases, have a look at our Github releases
Every deployment of the Beam API leads to a new patch version of the clients being released. With every release, the release description in the Github release contains a description that explains the difference between the previous and new version based on the REStful endpoints.
In the future, we hope to automatically assess major, minor and patch versions, but we currently rely on patch incrementals only.
Beam OpenAPI specification
Beam OpenAPI specification empowers you with a broad set of developer tooling, starting with Postman collections and generating your own SDK. It also serves as the basis for our generated release changelogs and clients.