Skip to content

Commit

Permalink
chore: improve sdk docs (#101)
Browse files Browse the repository at this point in the history
* chore: improve sdk docs

* chore: improve sdk docs
  • Loading branch information
Robby Uitbeijerse authored Nov 10, 2023
1 parent c52bfd9 commit d9a81c6
Showing 1 changed file with 28 additions and 5 deletions.
33 changes: 28 additions & 5 deletions pages/service/sdk.mdx
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
import { Callout, Cards, Card } from "nextra/components";

# SDK
# Beam Accounts SDK

The recommended way to interact with the Beam API is by using one of our official SDKs. All of the provided SDKs are meant to be used **server side**, as it's crucial to not expose any of the api keys we provided publicly.

At the time of writing, the SDKs we're shipping are all automatically generated after every service release. We're currently using [OpenAPI generator](https://openapi-generator.tech/) and [OpenAPI Typescript Codegen](https://www.npmjs.com/package/openapi-typescript-codegen).

<Callout emoji="⚠️">
It's of the utmost importants that your api key never gets exposed. If your
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
[email protected].
[email protected]. Alternatively: re-create your API keys yourself using the
provided regenerate-key, the old ones will automatically be invalidated.
</Callout>

---

### Beam SDKs

In order to get started, we currently provide the following SDKs. Note that if there's no available SDK available for your preferred language, there's always the possibility of directly connecting to Beam it's RESTful API.
In order to get started, we currently provide the following SDKs. Note that if there's no available SDK 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.

<Cards>
<Card
Expand All @@ -27,8 +32,26 @@ In order to get started, we currently provide the following SDKs. Note that if t
/>
</Cards>

---

### Beam SDK repository

If you're interseted in how we generate the SDK, have a look at the [Github repository](https://github.com/Merit-Circle/beam-sdk). If you don't want to use our provided SDKs, 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](https://github.com/Merit-Circle/beam-sdk/releases)

Every deployment of the Beam API leads to a new **patch** version of the SDK 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.
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 SDKs.

[Beam OpenAPI Specification](https://api.testnet.onbeam.com/api/game-json)

1 comment on commit d9a81c6

@vercel
Copy link

@vercel vercel bot commented on d9a81c6 Nov 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

beam-docs – ./

beam-docs-git-main-merit-circle.vercel.app
beam-docs-merit-circle.vercel.app
docs.onbeam.com

Please sign in to comment.