Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bodrovis committed Aug 23, 2023
1 parent 9d9e3cb commit ad7c133
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
4 changes: 4 additions & 0 deletions docs/additional_info/changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## 11.0.0 (23-Aug-2023)

* Added support for the OTA endpoints. Please refer to the [OTA introduction article](https://lokalise.github.io/node-lokalise-api/ota/introduction) to learn more.

## 10.0.0 (5-Jul-2023)

* Require Node 16+ (version 14 has reached EOL)
Expand Down
10 changes: 5 additions & 5 deletions docs/ota/introduction.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# Introduction

While OTA (over-the-air) endpoints are part of the main Lokalise API, it has certain specifics.
While OTA (over-the-air) endpoints are part of the main Lokalise API, they have certain specifics.

In order to address those, the SDK introduces two additional clients:
In order to address those specifics, the SDK introduces two additional clients:

* `LokaliseApiOta` — you'll use this client to create OTA SDK tokens, create bundle freezes, publish bundles, and so on. This client requires a specially generated JWT (see below).
* `LokaliseOtaBundles` — this client is utilized only to request OTA bundles and it requires an OTA SDK token.

**[Please refer to the following guide to learn about the OTA API in general.](https://developers.lokalise.com/reference/working-with-the-ota-api)**
[Please refer to the following guide to learn about the OTA API in general.](https://developers.lokalise.com/reference/working-with-the-ota-api)

**[To learn about the library requirements and the installations process, please refer to the Getting started article.](https://lokalise.github.io/node-lokalise-api/api/getting-started)**
[To learn about the Node SDK requirements and the installation process, please refer to the Getting started article.](https://lokalise.github.io/node-lokalise-api/api/getting-started)

## Managing bundles and tokens

So, basically you'll use the `LokaliseApiOta` for all the OTA endpoints except for the [Get OTA bundle](https://developers.lokalise.com/reference/get-ota-bundle).

All endpoints supported by the `LokaliseApiOta` client require the usage of a JWT. Therefore, to get started you'll need to generate your JWT using the regular Lokalise Node SDK:
All endpoints supported by the `LokaliseApiOta` client require the usage of a JWT (in other words, you **cannot use the regular Lokalise API token**). Therefore, to get started you'll need to generate your JWT:

```ts
import { LokaliseApi } from "@lokalise/node-api";
Expand Down

0 comments on commit ad7c133

Please sign in to comment.