Zum Inhalt springen

Apps und API

6 grundlegende Funktionen · 23 seit dem Fork hinzugekommen

Was Catodon bietet

Misskey-API

Entwickeln Sie Bots und Clients auf einer vollständigen REST- und Streaming-API mit einer Konsole in der App.

Die API-Konsole: der Endpunkt users/show, mit einem Benutzernamen aufgerufen, und das JSON, das der Server geantwortet hat.

Mastodon-API

Von Catodon verbessert

Verwenden Sie Mastodon- und Pixelfed-Apps mit Ihrem Konto, über eine native Mastodon-API.

ActivityPub-Föderation

Von Catodon verbessert

Folgen Sie Mastodon, Lemmy, PeerTube und anderen Servern im ganzen Fediverse und tauschen Sie sich mit ihnen aus.

Webhooks

Von Catodon verbessert

Senden Sie Ereignisse an Ihre eigenen Dienste, mit signierten Zustellungen und einem Zustellprotokoll.

Die Liste „Letzte Zustellungen“ eines Webhooks für ein Konto: jeder Versuch mit seinem Ereignis, dem Status, den der Empfänger geantwortet hat, 204 oder 410, wann und wie lange es dauerte, und jeweils einer Schaltfläche „Erneut senden“.

Lemmy-kompatible API

Von Catodon entwickelt

Lassen Sie Lemmy-Apps und -Websites die öffentlichen Foren des Servers auflisten.

Der Abschnitt „Lemmy-kompatible Forum-API“ der Föderationsrichtlinie in der Systemsteuerung, mit seinem Schalter und einer Erklärung, was Forenverzeichnisse lesen können.

Bei Apps anmelden

Von Catodon verbessert

Autorisieren Sie Apps von Drittanbietern mit OAuth, MiAuth oder über eine Webadresse identifizierte Apps.

Neu in jeder Version

Die ganze Unterhaltung eines Beitrags in einer einzigen Anfrage

26.10.0

Ein neuer Endpunkt notes/context liefert die Antworten oberhalb und unterhalb eines Beitrags in Thread-Reihenfolge, innerhalb derselben Grenzen wie bei Mastodon. Er speist die Thread-Ansicht von Mastodon-Apps; die eigenen Thread-Ansichten von Catodon verwenden ihn nicht.

Registrierung über Mastodon-Apps

26.11.0

Eine App, die anbietet, ein Konto zu erstellen, etwa die von Mastodon selbst, kann das nun auf einem Catodon-Server über Mastodons POST /api/v1/accounts tun und beachtet dabei jede Regel des eigenen Formulars des Servers: Einladungen, Freigabe, E-Mail-Bestätigung, Mindestalter und reservierte Benutzernamen. Jede Ablehnung wird dem jeweiligen Feld zugeordnet. Ein Server mit Captcha lehnt Registrierungen aus Apps ab, und App-Registrierungen sind pro IP-Adresse und pro App ratenbegrenzt.

Anmelden mit Pixelix und anderen Pixelfed-Apps

26.10.0

Zwei Dinge hielten sie davon ab: Dem von Catodon ausgehändigten Token fehlte ein Feld, auf dem die App bestand, und eine App, die keinen bestimmten Zugriff anfordert, konnte nur lesen. Beides ist behoben, und eine solche App lässt Sie bei der Autorisierung jetzt zwischen „nur lesen“ und „lesen und schreiben“ wählen.

Die Autorisierungsseite für eine App, die keinen bestimmten Zugriff angefordert hat, mit den Optionen „Nur lesen“ oder „Lesen und schreiben“.

Geplante Beiträge aus Mastodon-Apps

26.9.0

Mastodon-Apps können Beiträge über die Mastodon-API planen.

Wortfilter sind Mastodons Filter

26.10.0

Die Mastodon-Filterrouten lesen und schreiben jetzt genau die Filter, die der Einstellungsbildschirm zeigt, sodass ein in Tusky erstellter derselbe ist, der hier angezeigt wird, und umgekehrt. Bisher wurde das, was ein Mastodon-Client einstellte, pro Zugriffstoken gemerkt und filterte gar nichts.

Ein ganzer Antwortbaum für Apps

26.11.0

Der neue Endpunkt notes/thread liefert die Antworten unter einem Beitrag in einer einzigen Anfrage über mehrere Ebenen, als flache Liste, in der jede Antwort ihren Elternbeitrag nennt, mit einem Cursor überall dort, wo weitere Antworten folgen. Er sortiert auf jeder Ebene nach Beliebtheit, ältesten oder neuesten, nimmt Grenzen für seine Größe entgegen und lässt Antworten, die Sie nicht sehen können, samt allem darunter weg.

Neuester Beitrag jedes gefolgten Hashtags, für Apps

26.11.0

Der neue Endpunkt notes/followed-hashtags liefert für jeden Hashtag, dem Sie folgen, seinen neuesten öffentlichen Beitrag, den neuesten zuerst, mit denselben Filtern und derselben Seitenaufteilung wie notes/following. Beiträge von stummgeschalteten, blockierten oder gesperrten Konten und Servern sowie Beiträge mit einem von Ihnen blockierten Hashtag werden weggelassen.

Übersetzung in Mastodon-Clients

26.10.0

Die Mastodon-Übersetzungsroute antwortet jetzt vom Übersetzer, den der Server bereits für seine eigenen Beiträge verwendet, und der Server kündigt die Funktion und die Sprachen an, in die er übersetzt, sodass Tusky seine Übersetzen-Schaltfläche anbietet, sobald es das Flag sieht.

Zugangsdaten müssen jetzt vor der Datei in einem Upload stehen

26.10.0

Bei einem Endpunkt, der Zugangsdaten verlangt und eine Datei entgegennimmt, muss das Zugangsdatum im Multipart-Body vor der Datei stehen. Früher wurde der gesamte Body zuerst eingesammelt, was bedeutete, einen kompletten Upload auf die Festplatte zu schreiben, bevor feststand, ob der Absender ihn überhaupt senden durfte.

Exklusive Listen über die Mastodon-API

26.10.0

Catodon bietet bei einer Liste seit jeher „Von der Startseite ausblenden“, doch seine Mastodon-Ausgabe ignorierte es: Das Feld wurde als unbekannt gemeldet und verworfen, wenn ein Client es setzen wollte. Clients anderer Anbieter sehen und ändern jetzt dasselbe wie ein Catodon-Konto.

Beschreibungen von Avatar und Kopfbild über die API

26.10.0

Sie wurden schon immer gespeichert und in beide Richtungen föderiert; nichts las sie wieder aus. Beide APIs melden sie jetzt überall, wo das Konto Gegenstand der Anfrage ist, und die Mastodon-Update-Route schreibt sie auf die im selben Aufruf genannten Bilder. Der Web-Client zeigt oder bearbeitet sie noch nicht.

Globale Chronik-Optionen für Empfohlen

26.11.0

Für Apps nimmt notes/bubble-timeline nun dieselben Optionen wie notes/global-timeline: Sortierung nach „Beliebt“ und „Aktiv“ sowie Schalter für Antworten und Forenbeiträge, jeweils mit dem als Standard, was Empfohlen bisher lieferte. Empfohlen lässt nun auch Antworten auf Beiträge nur für Follower von Autoren weg, denen Sie nicht folgen, wie es Global tut.

Apps, die sich ohne Registrierung anmelden, und die ActivityPub-Client-API

26.10.0

Eine App kann sich anmelden, ohne vorher registriert zu sein, identifiziert durch eine Webadresse, die sie beschreibt, und sich per PKCE ausweisend; die Zustimmungsseite zeigt ihren Namen und ihr Symbol. Apps, die die ActivityPub-Client-zu-Server-API verwenden, können dann über die Outbox des Kontos posten, folgen, reagieren, die Startseiten-Chronik lesen und mehr. Sie ist standardmäßig aktiviert, und unter Systemsteuerung → Föderation → Richtlinie lässt sich die ActivityPub-Client-API ausschalten.

Der Abschnitt „ActivityPub-Client-API“ der Föderationsrichtlinie in der Systemsteuerung, mit seinem Schalter und einer Erklärung, was ActivityPub-Apps nach der Anmeldung tun können.

In der API-Beschreibung deklarierte Foreneinstellungen

26.10.0

Drei Forenfelder, die der Server bereits sendete – ob ein Forum für Erwachsene ist und zwei Einschränkungen, wer posten darf –, sind jetzt in der API-Beschreibung deklariert, und die generierten misskey-js-Typen folgen. Nichts von dem, was der Server sendet, ändert sich.

Listenmitglieder erneut föderieren

26.11.0

admin/user-lists/ensure-proxy-follows ist für Administratoren gedacht: Der Endpunkt findet die entfernten Konten, die in irgendeiner Liste stehen und denen kein lokales Konto folgt, und lässt das Proxy-Konto ihnen folgen. So bleiben Listenmitglieder, die hinzugefügt wurden, während das Proxy-Konto ausgeschaltet war, nicht länger stumm. Mit dryRun: true listet er sie nur auf, und jeder Lauf wird im Moderationsprotokoll festgehalten.

Signierte Webhook-Zustellungen

26.11.0

Jede Zustellung eines Webhooks mit Secret trägt nun einen Header X-Catodon-Signature, einen HMAC-SHA256 aus einem Zeitstempel und dem Inhalt, mit diesem Secret als Schlüssel, sodass ein Empfänger prüfen kann, dass sie von Ihrem Server stammt und aktuell ist. Webhooks, die ohne Secret erstellt werden, erhalten nun ein zufälliges, und X-Misskey-Hook-Secret, das das Secret selbst sendet, ist veraltet und wird in 27.1.0 entfernt.

Ein Zustellprotokoll für Webhooks

26.11.0

Konto- und System-Webhooks listen nun ihre letzten 30 Zustellversuche auf: wann, welches Ereignis, der HTTP-Status oder warum keine Antwort kam und wie lange es dauerte. Eine Schaltfläche „Erneut senden“ sendet eine Zustellung erneut, die verloren ging, während Ihr Empfänger ausgefallen war, auch bei deaktiviertem Webhook, mit unveränderter eventId, damit ein Empfänger sie erkennen kann. Das Protokoll ist auch über i/webhooks/deliveries und admin/system-webhook/deliveries lesbar.

Die Liste „Letzte Zustellungen“ eines Konto-Webhooks: jeder Versuch mit seinem Ereignis, dem Status, den der Empfänger zurückgab, 204 oder 410, wann und wie lange es dauerte, und jeweils einer Schaltfläche „Erneut senden“.

Tote Webhooks abschalten

26.11.0

Ein Webhook, der 10 Ereignisse in Folge nicht zustellen kann, das erste mindestens eine Stunde zuvor, wird nun deaktiviert, statt für immer an eine tote Adresse zu senden, und sein Besitzer wird benachrichtigt: das Konto oder bei einem System-Webhook alle Moderatoren und Administratoren. Es zählen nur Ereignisse, die alle ihre Wiederholungen aufgebraucht haben, sodass ein kurzer Ausfall nichts ändert, und der Webhook lässt sich wieder einschalten, sobald sein Empfänger funktioniert.

Eine Benachrichtigung „Webhook deaktiviert“: Der Webhook „Live check“ ist immer wieder fehlgeschlagen und wurde deaktiviert; beheben Sie seinen Empfänger und aktivieren Sie ihn dann erneut.

Webhook-Ereignis für Benachrichtigungen

26.11.0

Konto-Webhooks unter Einstellungen > Entwickler erhalten die Option Beim Erhalt einer Benachrichtigung, die jede vom Konto empfangene Benachrichtigung als Ereignis notification sendet, Reaktionen eingeschlossen. Ihre Benachrichtigungseinstellungen gelten dabei, und der Schalter Beim Erhalt einer Reaktion entfällt, da reaction nicht mehr gesendet wird.

Die Auslöser-Schalter eines neuen Konto-Webhooks, zuletzt „Beim Erhalt einer Benachrichtigung“, eingeschaltet, mit der Erläuterung, dass jede vom Konto empfangene Benachrichtigung gesendet wird, Reaktionen eingeschlossen.

Beitragsfilter für Webhooks

26.11.0

Konto-Webhooks erhalten unter Einstellungen > Entwickler einen Abschnitt Beitragsfilter: ein Schalter pro Sichtbarkeit und eine Auswahl zwischen Autoren auf allen Servern, nur diesem Server oder nur anderen Servern. Die Filter gelten für die Ereignisse Beitrag, Bearbeitung, Antwort, Repost und Erwähnung, und i/webhooks/create und i/webhooks/update nehmen noteVisibilities und noteOrigin entgegen.

Der Abschnitt „Beitragsfilter“ eines neuen Konto-Webhooks: ein Schalter pro Sichtbarkeit, mit „Nachricht“ aus, und eine Auswahl „Autor“ zwischen allen Servern, diesem Server und anderen Servern.

System-Webhooks für Moderation und Registrierungen

26.11.0

System-Webhooks unter Systemsteuerung > Webhooks erhalten Wenn ein Moderator eine Aktion ausführt, das jede im Moderationsprotokoll festgehaltene Aktion als Ereignis moderationAction sendet, und Wenn eine Registrierung auf Freigabe wartet, das userPendingApproval mit dem bei der Registrierung angegebenen Grund sendet. Beide haben eine Testschaltfläche.

Das Fenster zum Erstellen eines System-Webhooks mit der Liste seiner Auslöser und zwei neuen, die eingeschaltet sind: „Wenn ein Moderator eine Aktion ausführt“ und „Wenn eine Registrierung auf Freigabe wartet“.

Push-Benachrichtigungen für Mastodon-Apps

26.11.0

Tusky, Pachli, Ice Cubes und andere Mastodon-Apps können sich nun für Push registrieren und erfahren so sofort von jeder neuen Benachrichtigung, statt alle 15 Minuten nachzusehen oder bei geschlossener App nichts zu erhalten. Die von der App angeforderten Benachrichtigungsarten und ihre Einstellung „von wem“ werden beachtet, und wird der Zugriff einer App widerrufen, wird auch ihr Abonnement entfernt. Es nutzt die bestehenden Web-Push-Einstellungen des Servers.