Developers

Introduction

This is the complete list of endpoints for the XirSys server API. With this list, you’ll be able to do many things — from dynamically creating XirSys rooms to reviewing your bandwidth and TURN usage.

If you haven’t already, we highly suggest that you first read our Introduction, followed by our Quick start guide. These guides should give you a fundamental understanding of our platform, making calling our XirSys servers a piece of cake.

In order to make calls to our API, you must make REST requests to https://service.xirsys.com/< API endpoint > with your XirSys credentials. Most calls require at the very least your XirSys ident (username) and secret, and some calls require more information than others. For example, adding an application with /application requires only a domain, whereas adding a room via /room requires both a domain and an application.

/signal/token

Method: GET or POST

This call grabs a secure WebSocket token from XirSys, which ensures that WebSocket data usage is restricted to only the application’s owner. The tokens themselves are encrypted, which is expected by the WebSocket endpoints and required to set up a successful connection. Invalid tokens or incomplete data within tokens result in an unsuccessful WebSocket connection. This is typically called whenever users have to interact with our signaling server.

Key  Value
ident Username
secret SecretKey
domain my.domain.com
application AppName
room RoomName
secure 0 or 1

 

/signal/list

Method: GET or POST

This grabs a list of XirSys WebSocket servers. This is typically only called with very rare use cases.

Key  Value
ident Username
secret SecretKey

/ice

Method: GET or POST

This is typically called when a user has to authenticate with our STUN and TURN servers. This follows a similar path to acquiring a WebSocket token, with the major difference being that — instead of returning a token — the request returns an array of WebRTC STUN and TURN servers.

Key  Value
ident Username
secret SecretKey
domain my.domain.com
application AppName
room RoomName

/domain

Method: GET = list domains, POST = add domain, DELETE = disable domain

This is used to manage XirSys domains.

Key  Value
ident Username
secret SecretKey
domain my.domain.com (to be created or disabled)

/application

Method: GET = list applications, POST = add application, DELETE = disable application

This is used to dynamically create XirSys applications.

Key  Value
ident Username
secret SecretKey
domain my.domain.com
application AppName (to be created or disabled)

/room

Method: GET = list rooms, POST = create room, DELETE = disable room

This is used to dynamically create XirSys rooms.

Key  Value
ident Username
secret SecretKey
domain my.domain.com
application AppName
room RoomName (to be created or disabled)

Conclusion

Achievement unlocked! You now have an arsenal with everything you need to deploy and maintain a production-grade WebRTC application.
For full documentation on our platform and some samples, click here

 

 


Developers