Dieses Dokument wurde von der Community übersetzt. Dokumentation hier übersetzen: Crowdin Vielen Dank für die Mitarbeit🙏
Einen Zugriffstoken erhalten
Um mit der Verwendung des APIs zu beginnen, wird zuerst ein Zugriffstoken benötigt. Wie ein solcher Token erhalten werden kann, und wie die API dann hiermit verwendet werden kann, wird auf dieser Seite erklärt.
Grundsätzlich benötigt die API ein Zugangs-Token, um eine Anfrage zu stellen. Das Zugriffstoken ist eine mit dem Nutzer verbundene Authentifizierungsinformation, die den Nutzer bei der Nutzung der API identifiziert und verwaltet, zu welchen Vorgängen der Nutzer für jedes Zugriffstoken berechtigt ist.
Es besteht eine eins-zu-viele-Beziehung zwischen einem Benutzer und dem diesem Benutzer zugeordneten Zugangs-Token, und für einen bestimmten Benutzer können mehrere Zugangs-Token ausgestellt werden.
Sie können auf einfache Weise Ihr eigenes Zugriffs-Token sowie die Zugriffs-Tokens von nicht spezifizierten Benutzern, die Ihre Anwendung nutzen werden, erhalten.
- Im ersten Fall: Gehe zu „Manuelles Ausstellen Ihres eigenen Zugangstokens “
- Im letzteren Fall: Fahren Sie fort mit ‚Den Benutzer der Anwendung auffordern, ein Zugriffstoken auszustellen‘
Einen Zugriffstoken für das eigene Benutzerkonto generieren
Sie können Ihr eigenes Zugangstoken in Misskey Web unter „Einstellungen > API“ vergeben.
Der Zugangstoken darf nicht an Dritte weitergegeben werden.
Einen Benutzer zur Generierung eines Zugangstokens für eine Anwendung auffordern
Um das Zugriffstoken eines Benutzers der Anwendung (im Folgenden einfach „Benutzer“ genannt) zu erhalten, verwenden Sie eine der folgenden Methoden.
MiAuth方式でのアクセストークン取得方式
v12.27.0以降で使用できる、Misskey独自の簡素な認証方法について説明しています。
OAuth方式でのアクセストークン取得方式
v2023.9.0以降で使用できる、OAuth2.0方式での認証方法について説明しています。
アプリ作成方式でのアクセストークン取得方法(旧来型)
MiAuth導入以前(v12.27.0未満)でのアクセストークン取得方法について説明しています。
Nutzung der API
Nach Erhalt des Zugangstokens kann die API durch Anfragen an die verschiedenen Endpunkte genutzt werden.
- Alle HTTP-APIs sind POST und sowohl Anfrage als auch Antwort sind im JSON-Format (außer drive/files/create).
- Geben Sie
Content-Type: application/json
in der Kopfzeile der Anfrage an. - Das Zugriffstoken ist im JSON-Körper der Anfrage mit dem Parameternamen „i“ enthalten.
- Die Basis-URL lautet „https://{Domäne des Servers}/api“.
Methoden mit Autorisierung Header
Geben Sie das Feld „Autorisierung“ im Header wie folgt an.
fetch("https://misskey.example/api/notes/create", {
method: 'POST',
body: JSON.stringify({
text: "Hello Misskey API World with My Application!"
}),
headers: {
Authorization: `Bearer ${accessToken}`,
'Content-Type': 'application/json',
},
credentials: 'omit',
});
Methoden via i
Beispiel für einen Body mit einem Access-Token (für Meta):.
{
"i": "HogEFugA1341",
"detail": false
}
Weitere Informationen über die API finden Sie in der API-Referenz.
Misskey verwendet kein REST.
Misskey bietet nicht nur eine HTTP-API, sondern auch eine Streaming-API an. Für weitere Details, schaue in die [Dokumentation(../streaming/).