MatrixAPI

Admin API

Todo

User API

Servereinstellungen bearbeiten in Windows (Mit App Bruno)

• Lade Bruno herunter von https://www.usebruno.com/ und starte Bruno.
• Wähle "Neue Kollektion"

In den folgenden Abschnitten erkläre ich wie Du neue Abfragen erstellst. In allen Fällen musst Du <Serveradresse> durch einen passenden Namen ersetzen. Zum Beispiel einen unserer drei Matrix Server:

• matrix02.desaive.de
• matrix.kingnet.berlin
• matrix.pussy-hosting.berlin

API Key abrufen

• Neuer Request
• Method: POST
• URL: <Serveradresse>/_matrix/client/r0/login
• Body - Type: JSON

{
  "type": "m.login.password",
  "user": "<username",
  "password": "<passwort>"
}

• Header
  • Content-Type application/json

Nutzerdaten abfragen

• Neuer Requeset
• Method: GET
• URL: <Serveradresse>/_matrix/client/v3/profile/<Matrix Adresse .. Bsp. @mel:desaive.de>
• Headers
  • Content-Type application/json

Anzeigenamen ändern

• Neuer Request
• Method: PUT
• URL: <Serveradresse>/_matrix/client/v3/profile/@mel:desaive.de/displayname
• Body - Type: JSON

{
  "displayname":"<Mein neuer Displayname"
}

• Header
  • Content-Type application/json
  • Authorization Bearer <API Key>

Servereinstellungen bearbeiten in Linux (Commandline)

Du kannst mit dem Matrix Server auch direkt über eine API sprechen. Dazu sendest Du Kommandos an eine Web Adresse. Die Adressen für unsere drei Server sind:

• matrix02.desaive.de
• matrix.kingnet.berlin
• matrix.pussy-hosting.berlin

In den weiter unten angegebenen Kommandos musst Du die Serveradresse jeweils durch die für die passende ersetzen!

Abfragen des API Schlüssels

Um Servereinstellungen bearbeiten zu können, musst Du zuerst Deinen API Key abfragen. Das geht mit dem folgenden Kommando:

Bitte gib dazu Deinen Benutzernamen z. Bsp. mel und Dein Passwort in dem Kommando mit:

# Kommando für Linux
curl -XPOST "https://<Serveradresse>/_matrix/client/r0/login" -H "Content-Type: application/json" -d '{"type": "m.login.password","user": "<Benutzername>","password": "<Passwort>"}'


# Alternativ kann auch in Windows ein ähnliches PowerShell Kommando genutzt werden. 
Invoke-RestMethod -Uri "https://matrix.pussy-hosting.berlin/_matrix/client/r0/login" -Method Post -Headers @{ "Content-Type" = "application/json" } -Body (@{ type = "m.login.password"; user = "<Benutzername>"; password = "<Passwort>" } | ConvertTo-Json)

Als Antwort erhälst Du einen Text der so ähnlich wie folgt aussieht:

{"user_id": "<User ID>","access_token": "<API key>","home_server": "kingnet.berlin","device_id": "<Device ID>"}

Der Wert hinter "<API Key>" ist dein API Key. Den musst Du kopieren.

Abfragen der Einstellungen

Dazu nutzt Du das folgende Kommando mit Deinem API key:

Ersetze <Persönliche Adresse> durch deine eigene Adresse, zum Beispiel @mel:desaive.de.

curl -X GET "https://<Serveradresse>/_matrix/client/v3/profile/<Persönliche Adresse>" -H "Content-Type: application/json"

Und bekommst als Antwort Deinen Anzeigenamen gezeigt.

{"displayname": "<Dein bisheriger Anzeigename>"}

Ändern Deines Anzeigenamens

Um den Anzeigenamen zu ändern kannst Du das folgende Kommando nutzen. Achte darauf folgende Werte im Kommando anzupassen:

Ersetze <Persönliche Adresse> durch deine eigene Adresse, zum Beispiel @mel:desaive.de und <Dein neuer Anzeigename> durch den Anzeigenamen, durch den Du in Zukunft bekannst sein möchtest. Zum Beipiel "Mel die Große" und nutze den <API Key>, den Du im ersten Kommando abgefragt hast.

curl -X PUT "https://<Serveradresse>/_matrix/client/v3/profile/<Persönliche Adresse>/displayname" -H "Authorization: Bearer <API key>" -H "Content-Type: application/json" -d '{"displayname":"<Dein neuer Anzeigename>"}'