REST API

Objectives

This section details the REST API that you can access to perform action regarding your provider.
The REST API is designed to access or to set persistent data on the cloud.

Contents

You will find here two chapters:

• Provider Rest API
• User Rest API

REST API Usage

Users

Users can use the API for managing meeting points, 6 digits or recording.

The key used to authenticate as user is composed of the appId and the token separated by a '/'.
Authentication is done in the header in the request with the following Authorization request header: Authorization: token Your_AppID/Your_Token

Please note that all user methods are prefixed with https://api.rtccloud.net/v2.0/user/

Providers

The key used to authenticate as user is the API Key of the provider and is the concatenation of your Authentication API Client Identifier and Authentication API Client Secret.
Authentication is done in the header of the request with the following Authorization request header: Authorization: Apikey Your_API_Key

Please note that all provider methods are prefixed with https://api.rtccloud.net/v2.0/provider/

Documentation Usage

The REST API documentation shows the complete list of methods that can be used but also gives a way to test the API using your credentials. Mandatory fields (mainly as part of the method url are tagged as required)

Users

To test the API as a user, you need to enter your appID and your token on the top right corner of the page.

Providers

To test the AP as a provider, you need to enter your API Key on the top right corner of the page.