Skip to content

API Endpoints

holema edited this page Jan 19, 2021 · 4 revisions

API

Mit der API ist es möglich Konferenzen durch eine andere Anwendung erzeugen zu lassen.

Es muss in die Datenbank ap_key manuel eine client_iD und ein client_secret eingeben werden. Bei jedem request an die API muss der der API Secret über den parameter clientSecret mitgegeben werden. Es sollten nur Zugriffe von einem Backend-Server auf den Jitsi-Admin durchgeführt werden.

Infos zu einer Konferenz (GET /api/v1/{uidReal})

Request

http://localhost:8000/api/v1/57d4d52d3c1f38c28e9f101f031a631f

Response

{
"error": false,
"teilnehmer": [
"[email protected]"
],
"start": "2021-02-02CET13:00:00",
"end": "2021-02-02CET13:45:00",
"duration": 45,
"name": "testAPINEW",
"moderator": "[email protected]",
"server": "serverurl",
"joinBrowser": "http://localhost:8000/room/join/b/84",
"joinApp": "http://localhost:8000/room/join/a/84"
}

Eine Konferenz erstellen (POST /api/v1/room)

Request:

http://localhost:8000/api/v1/room
[email protected]
&name=testAPINEW
&duration=70
&server=serverURL
&start=2021-02-01T13:00
&clientSecret=secret
&keycloakId=id des Users

Response:

{
"error": false,
"uid": "57d4d52d3c1f38c28e9f101f031a631f",
"text": "Meeting erfolgreich angelegt"
}

Eine Konferenz bearbeiten (PUT /api/v1/room)

Request:

http://localhost:8000/api/v1/room
?name=testAPINEW
&duration=45
&server=serverURL
&start=2021-02-02T13:00
&clientSecret=secret
&uid=57d4d52d3c1f38c28e9f101f031a631f

Response:

{
"error": false,
"uid": "57d4d52d3c1f38c28e9f101f031a631f",
"text": "Meeting erfolgreich geändert"
}

Eine Konferenz Löschen (DELETE /api/v1/room)

Request:

http://localhost:8000/api/v1/room
?uid=57d4d52d3c1f38c28e9f101f031a631f
&clientSecret=secret

Response

{
"error": false,
"text": "Erfolgreich gelöscht"
}

Einen Teilnehmer zu einer Konferenz hinzufügen (POST /api/v1/user)

Request:

http://localhost:8000/api/v1/user
?uid=57d4d52d3c1f38c28e9f101f031a631f
&[email protected]
&clientSecret=secret

Response

{
"uid": "57d4d52d3c1f38c28e9f101f031a631f",
"user": "[email protected]",
"error": false,
"text": "Teilnehmer [email protected] erfolgreich hinzugefügt"
}

Einen Teilnehmer von einer Konferenz löschen (DELETE / api/v1/user)

Request:

http://localhost:8000/api/v1/user
?uid=57d4d52d3c1f38c28e9f101f031a631f
&[email protected]
&clientSecret=secret

Response

{
"uid": "57d4d52d3c1f38c28e9f101f031a631f",
"user": "[email protected]",
"error": false,
"text": "Teilnehmer [email protected] erfolgreich gelöscht"
}

Infos zu einem User (GET /api/v1/serverInfo)

Request

http://localhost:8000/api/v1/serverInfo
[email protected]
&keycloakId=id
&clientSecret=secret

Response

{
"server": [
"url1",
"url2",
"url3"
],
"email": "[email protected]",
"error": false
}