Learn how to interact with ApiRTC Platform.

ApiRTC platform is compound of software layers to enables communication between people through client applications.

ApiRTC REST API and WebHooks enable interaction between your backend and ApiRTC backend.

REST API

The main usage of the REST API is provisioning of Enterprises and Users. But the REST API also allows to retrieve communication data, such as recorded videos.

Authentication

ApiRTC REST API supports HTTP Bearer authentication. In order to authenticate, you must get a token by issuing a POST /token, providing username and password of your ApiRTC account.

Provisioning

Enterprises

The concept of Enterprise in ApiRTC simplifies configuration, reporting, and billing of different projects.

When you create your ApiRTC account, you get an Enterprise and an admin User. You can then create sub-accounts as sub-Enterprise with associated admin User.

Users

You can use CRUD operations on Users.

Medias management

Retrieve or delete medias exchanged or recorded during conversations.

WebHooks

To get notified of some communication or platform events, ApiRTC can trigger WebHooks to your backend server.

WebHooks are triggered asynchronously.

To handle WebHooks, your backend needs to accept HTTP requests. When some event occurs, ApiRTC makes a POST HTTP request to the URL you have configured for your WebHooks.

The request includes details of the event. Your backend can then perform whatever logic is necessary.

Example of a webhook payload corresponding to a conversationEnded event: