Getting started

How to get started using the Confrere API

To begin consuming our API, activate API-access under the “Settings” tab on the dashboard. You will then obtain client credentials, a client_id, and a client_secret which will be used to communicate with our API through HTTP Basic Auth. In addition, you will be asked to provide a Webhook where events from our backend will be POSTed and which you can react to (such as a video call being ended).

Our API is based on REST, and has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which are understood by off-the-shelf HTTP clients. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your secret API key in any public website's client-side code). JSON is returned by all API responses.