-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.md-e
70 lines (47 loc) · 2.59 KB
/
README.md-e
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# [Sendbird Python Platform SDK](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api)
[](/docs)
This is a python library 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.
# 🔥 Quick start
```python
import sendbird_platform_sdk
from sendbird_platform_sdk.api import user_api
from pprint import pprint
configuration = sendbird_platform_sdk.Configuration(
host = "https://api-YOUR_APP_ID_FROM_DASHBOARD.sendbird.com"
)
with sendbird_platform_sdk.ApiClient(configuration=configuration) as api_client:
api_instance = user_api.UserApi(api_client)
api_token = "YOUR_MASTER_API_TOKEN_FROM_DASHBOARD"
try:
api_response = api_instance.list_users(api_token=api_token, limit=1)
pprint(api_response)
except sendbird_platform_sdk.ApiException as e:
print("Exception when calling UserApi->list_users: %s\n" % e)
```
# ⚒️ 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
This package has been tested with python version 3.9.10
# ⚙️ Installation
see Local Development
# 🤓 Local Development
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
# 🗃️ 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)|
| Application | [docs/ApplicationApi.md](docs/ApplicationApi.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) |
| Webhooks | [docs/WebhooksApi.md](docs/WebhooksApi.md) |