Deploy a middleware server

To streamline token authentication and REST API workflows in your infrastructure, Agora's developer community offers the open-source Agora Go Backend Middleware. The backend provides RESTful APIs for tasks such as token generation, cloud recording management, and real-time transcription. This guide shows you how to implement a token server using the community middleware for Video Calling.

Understand the tech

The following figure illustrates the architecture of the middleware token generation microservice.

Set up and run the Go backend middleware

Take the following steps to set up and run the middleware project:

1. Clone the repository

   git clone https://github.com/AgoraIO-Community/agora-go-backend-middleware.git

2. Install dependencies

Ensure you have Go installed on your system. Navigate to the project directory and install the project dependencies:

cd agora-go-backend-middleware
go mod download

3. Configure environment variables

   Copy the example .env file.

   cp .env.example .env

   Update the following variables in the .env file:

   • APP_ID: Your Agora App ID.
   • APP_CERTIFICATE: Your Agora App Certificate.

4. Run the middleware

Start the middleware server using the following command:

go run cmd/main.go

The middleware runs on the default port, for example localhost:8080.

Generate tokens

Refer to the following curl example to test the middleware's token generation API endpoint.

POST: /token/getNew

curl -X POST http://localhost:8080/token/getNew \
-H "Content-Type: application/json" \
-d '{
 "tokenType": "rtc",
 "channel": "testChannel",
 "role": "publisher",
 "uid": "12345",
 "expire": 3600
}'

Reference

This section contains content that completes the information on this page, or points you to documentation that explains other aspects to this product.

Middleware token generation API

This section provides details about the middleware token generation API endpoints.

Generate Token

Generates a Video SDK, Signaling, or Chat token based on the provided parameters.

Endpoint

POST /token/getNew

Request body

{
 "tokenType": "rtc|rtm|chat",
 "channel": "string",
 "uid": "string",
 "role": "publisher|subscriber",
 "expire": 0
}

Response

{
 "token": "string"
}