Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fab-it-hub/agora-token-service
https://github.com/fab-it-hub/agora-token-service
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fab-it-hub/agora-token-service
- Owner: fab-it-hub
- License: mit
- Created: 2022-12-23T03:33:07.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2022-12-23T03:33:11.000Z (about 2 years ago)
- Last Synced: 2023-07-20T07:37:24.521Z (over 1 year ago)
- Language: Go
- Size: 12.1 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Agora Token Webservice
 
Written in Golang, using [Gin framework](https://github.com/gin-gonic/gin) to create a RESTful webservice for generating user tokens for use with the [Agora.io](https://www.agora.io) platform.
Agora Advanced Guide: [Token Management](https://docs.agora.io/en/video-calling/develop/authentication-workflow).
## Deploy to Railway.app ##
[](https://railway.app/new/template/NKYzQA?referralCode=waRWUT)
## Deploy to Render ##
## Deploy to Heroku ##
[](https://www.heroku.com/deploy/?template=https://github.com/AgoraIO-Community/agora-token-service)
## How to Run ##
Set the APP_ID and APP_CERTIFICATE env variables.
```bash
cp .env.example .env
```
```bash
go run cmd/main.go
```
Without using `.env`, you can also set the environment variables as such:
```bash
APP_ID=app_id APP_CERTIFICATE=app_cert go run cmd/main.go
```
---
The pre-compiled binaries are also available in [releases](https://github.com/AgoraIO-Community/agora-token-service/releases).
## Docker ##
#1. To build the container, with app id and certificate:
```bash
docker build -t agora-token-service --build-arg APP_ID=$APP_ID APP_CERTIFICATE=$APP_CERTIFICATE .
```
#2. Run the container
```bash
docker run agora-token-service
```
> Note: for testing locally
```bash
docker run -p 8080:8080 agora-token-service
```
## Endpoints ##
### Ping ###
**endpoint structure**
```bash
/ping
```
response:
``` json
{"message":"pong"}
```
### RTC Token ###
The `rtc` token endpoint requires a `tokenType` (uid || userAccount), `channelName`, and the user's `uid` (type varies based on `tokenType`).
`expiry(optional)` Pass an integer to represent the token lifetime in seconds.
**endpoint structure**
```
/rtc/:channelName/:role/:tokenType/:rtcuid/?expiry=3600
```
response:
``` json
{"rtcToken":" "}
```
## RTM Token ##
The `rtm` token endpoint requires the user's `rtmuid`.
`expiry(optional)` Pass an integer to represent the privelege lifetime in seconds.
**endpoint structure**
```
/rtm/:rtmuid/?expiry=3600
```
response:
``` json
{"rtmToken":" "}
```
### Both Tokens ###
The `rte` token endpoint generates both the `rtc` and `rtm` tokens with a single request. This endpoint requires a `tokenType` (uid || userAccount), `channelName`, the user's `rtcuid` (type varies `String/Int` based on `tokenType`) and `rtmuid` which is a `String`. Omitting `rtmuid` will assume it's the same as `rtcuid`.
`expiry(optional)` Pass an integer to represent the token lifetime in seconds.
**endpoint structure**
```
/rte/:channelName/:role/:tokenType/:rtcuid/:rtmuid/?expiry=3600
```
response:
``` json
{
"rtcToken":"rtc-token-djfkaljdla",
"rtmToken":"rtm-token-djfkaljdla"
}
```