https://github.com/sendbird/sendbird-platform-sdk-javascript
Sendbird Platform API JavaScript SDK
https://github.com/sendbird/sendbird-platform-sdk-javascript
Last synced: 6 months ago
JSON representation
Sendbird Platform API JavaScript SDK
- Host: GitHub
- URL: https://github.com/sendbird/sendbird-platform-sdk-javascript
- Owner: sendbird
- License: mit
- Created: 2021-11-10T20:35:14.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-07-27T02:31:22.000Z (11 months ago)
- Last Synced: 2025-10-04T11:56:26.383Z (9 months ago)
- Language: JavaScript
- Homepage:
- Size: 2.69 MB
- Stars: 4
- Watchers: 20
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE.md
Awesome Lists containing this project
README
# [Sendbird JavaScript Platform SDK](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api)
[](/docs)
[](https://www.npmjs.com/package/sendbird-platform-sdk)
This is a Node.js package that makes talking to the [Sendbird Platform API](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api) easier. With this library you can extend your Sendbird integration to include advanced features like channel automation and user management.
>__Note__: Platform API SDK v2 includes only the APIs that were actively used in v1. If you need help getting started with the new SDK, [contact us](https://dashboard.sendbird.com/settings/contact_us).
# Install
```npm install @sendbird/sendbird-platform-sdk-javascript```
# 🔥 Quick start
```javascript
import SendbirdPlatformSdk from '@sendbird/sendbird-platform-sdk-javascript';
const userId = "1234";
const name = "bob";
const profileUrl = "https://picsum.photos/200";
const apiToken = "YOUR_API_TOKEN";
const appId = "YOUR_APP_ID";
const opts = {
createAUserRequest: new SendbirdPlatformSdk.CreateAUserRequest(
userId,
name,
profileUrl
),
};
async function createUser() {
const userApiInstance = new SendbirdPlatformSdk.UserApi();
userApiInstance.apiClient.basePath = `https://api-${appId}.sendbird.com`;
try {
const data = await userApiInstance.createAUser({apiToken, ...opts});
console.log(data);
} catch (e) {
console.log(e);
}
}
createUser();
```
# ⚒️ Prerequisite
In order to make requests with this SDK you will need you master API token. This can be found through the [Sendbird dashboard](https://dashboard.sendbird.com/). Each app you create in Sendbird has its own master api token. These tokens can be found in Settings > Application > General.
# 💻 Requirements
You will need [Node.js](https://nodejs.org/en/download/) installed. This has been developed and tested with NodeJS 17+.
# 📦 Installation
You can install the SDK directly from npm:
```
# Using npm
npm install @sendbird/sendbird-platform-sdk-javascript
# Using yarn
yarn add @sendbird/sendbird-platform-sdk-javascript
```
> ⚠️ This SDK is intended for use in server-side environments only. Do not use it in browsers or frontend applications.
# 🤓 Local Development
To run locally we need to make use of the [npm link](https://docs.npmjs.com/cli/v8/commands/npm-link) command. You will require two terminal tabs.
Please follow these steps:
##### Terminal 1
1. Clone this repo to your machine ```git clone git@github.com:sendbird/sendbird-platform-sdk-javascript```
2. Move into the newly cloned repo ```cd sendbird-platform-sdk-javascript```
3. Install node modules ```npm install```
4. Build the bundled JS ```npm run build```
5. Link the package ```npm link```
##### Terminal 2
1. Create a new npm package or move into and existing one ```mkdir app-using-sendbird-chat```
```npm init -y```
2. Link package to sendbird-platform-sdk ```npm link path/to/sdk/sendbird-platform-sdk-javascript```
The linking step is demonstrated visually here.
# 🗃️ Documentation
All the documentation for this project lives in the /docs directory of this repo.
##### Helpful links
| | Documentation |
| ----------- | ----------- |
| Announcement | [docs/AnnouncementApi.md](docs/AnnouncementApi.md)|
| Bot | [docs/BotApi.md](docs/BotApi.md) |
| GroupChannel | [docs/GroupChannelApi.md](docs/GroupChannelApi.md) |
| Message | [docs/MessageApi.md](docs/MessageApi.md) |
| OpenChannel | [docs/OpenChannelApi.md ](docs/OpenChannelApi.md) |
| User | [docs/UserApi.md](docs/UserApi.md) |
| Moderation | [docs/ModerationApi.md](docs/ModerationApi.md) |