!Sendbird banner image

Sendbird JavaScript Platform SDK


This is a Node.js package that makes talking to the Sendbird Platform 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.

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. Each app you create in Sendbird has its own master api token. These tokens can be found in Settings > Application > General.

!how to find you api token

💻 Requirements

You will need Node.js 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 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.

!npm link walkthrough

🗃️ Documentation

All the documentation for this project lives in the /docs directory of this repo.

##### Helpful links

| | Documentation |
| ----------- | ----------- |
| Announcement | docs/AnnouncementApi.md|
| Bot | docs/BotApi.md |
| GroupChannel | docs/GroupChannelApi.md |
| Message | docs/MessageApi.md |
| OpenChannel | docs/OpenChannelApi.md |
| User | docs/UserApi.md |
| Moderation | docs/ModerationApi.md |