Authentification
Pour utiliser cette api, vous devez nous contacter à
contact@immosquare.com. Après vérification nous vous fournirons une clé et un token pour vous connecter à l'api. Il vous suffira ensuite d'appeler l'api avec vos identifiants et de les envoyer dans le header de la requête REST.
POST /path
Content-Type: application/json
apiKey: xz1232xzd213213er213213dczxcc3loizxzs12dczx
apiToken: xz1287xzdwer213213dczxcas12dczx
GET /path
apiKey: xz1232xzd213213er213213dczxcc3loizxzs12dczx
apiToken: xz1287xzdwer213213dczxcas12dczx
Erreurs
videoconnect utilise des codes conventionnels de réponse HTTP pour indiquer le succès ou l'échec d'une requêtes API.
En général, les codes débutant par 2xx indiquent un succès, les codes débutant par 4xx indiquent une error qui résulte des informations fournies lors de l'appel ( par exemple : un paramètre est manquant,... ), et les codes débutant par 5xx indiquent une erreur interne sur notre serveur.
| HTTP Statut |
Code Description |
| 200 - OK |
Succès de la requête. |
| 400 - Bad Request |
Paramètres manquants, mauvais type envoyé,... |
| 401 - Unauthorized |
API Key/token invalide |
| 402 - Request Failed |
Paramètres ok mais la requête a échoué |
| 404 - Not Found |
Cette requête n'existe pas |
| 429 - Too Many Requests |
Trop de requête |
| 500, 502, 503, 504 - Server Errors |
Erreur interne |
Rooms
A room represents a specific video call location and configuration. You can create, retrieve update, and delete rooms with the VIDEO CONNECT API.
Create a room
POST https://videoconnect.app/api/v1/rooms
Call
{
"id": "aVZOke",
"name": "My first room",
"color": "#5f5f5f",
"created_at": "2021-04-17T13:10:13.539229-04:00"
}Response
{
"id": "aVZOke",
"name": "My first room",
"color": "#5f5f5f",
"created_at": "2021-04-17T13:10:13.539229-04:00"
}Retrieve a room
GET https://videoconnect.app/fr/api/v1/rooms/aVZOke
Response
{
"id": "aVZOke",
"name": "My first room",
"color": "#5f5f5f",
"created_at": "2021-04-17T13:10:13.539229-04:00",
"participants": [
{
"id": "Z8zQ4v",
"room_id": "aVZOke",
"username": "John Doe",
"video_and_audio_on": true,
"language": "fr",
"created_at": "2021-04-25T14:13:56.466154-04:00"
}
]
}Update a room
POST https://videoconnect.app/fr/api/v1/rooms/aVZOke
Call
{
"name": "My first room",
"color": "#5f5f5f"
}Response
{
"id": "aVZOke",
"name": "My first room",
"color": "#5f5f5f",
"created_at": "2021-04-17T13:10:13.539229-04:00"
}Delete a room
DELETE https://videoconnect.app/fr/api/v1/rooms/aVZOke
Response
{
"id": "aVZOke",
"name": "My first room",
"color": "#5f5f5f",
"created_at": "2021-04-17T13:10:13.539229-04:00"
}Participants
Participants control room access and session configuration on a per-user basis.A participant can join a room with a valid meeting token. You can use the parameters to configure how a participant experiences the meeting (e.g. what call features are available).
Create a participant
POST https://videoconnect.app/api/v1/participants
Call
{
"id": "Z8zQ4v",
"room_id": "aVZOke",
"username": "John Doe",
"video_and_audio_on": true,
"language": "fr",
"created_at": "2021-04-25T14:13:56.466154-04:00"
}Response
{
"id": "Z8zQ4v",
"room_id": "aVZOke",
"username": "John Doe",
"video_and_audio_on": true,
"language": "fr",
"created_at": "2021-04-25T14:13:56.466154-04:00"
}Retrieve a participant
GET https://videoconnect.app/fr/api/v1/participants/Z8zQ4v
Response
{
"id": "Z8zQ4v",
"room_id": "aVZOke",
"username": "John Doe",
"video_and_audio_on": true,
"language": "fr",
"created_at": "2021-04-25T14:13:56.466154-04:00"
}Update a participant
POST https://videoconnect.app/fr/api/v1/participants/Z8zQ4v
Call
{
"room_id": "aVZOke",
"username": "John Doe",
"video_and_audio_on": true,
"language": "fr"
}Response
{
"id": "Z8zQ4v",
"room_id": "aVZOke",
"username": "John Doe",
"video_and_audio_on": true,
"language": "fr",
"created_at": "2021-04-25T14:13:56.466154-04:00"
}Delete a participant
DELETE https://videoconnect.app/fr/api/v1/participants/Z8zQ4v
Response
{
"id": "Z8zQ4v",
"room_id": "aVZOke",
"username": "John Doe",
"video_and_audio_on": true,
"language": "fr",
"created_at": "2021-04-25T14:13:56.466154-04:00"
}Events
Vous pouvez paser des events lorsque le meeting est en cours. Voici la liste des events disponibles
Create an Action
POST https://videoconnect.app/fr/api/v1/events
Call
{
"room_event": "activate-video-and-audio",
"room_id": "aVZOke",
"participant_id": "Z8zQ4v"
}