Routenübersicht

Jeder Pfad unten liegt unter http://127.0.0.1:19821 und stammt aus dem eigenen OpenAPI-Dokument des Dienstes. Nur /api/v1/token in der ersten Gruppe ist ohne Bearer-Token erreichbar.

Trägt das Dokument für eine Route keine Beschreibung, wird hier keine erfunden. Ruf /api/v1/openapi.json ab, oder öffne /api/v1/docs, für die Schemata von Anfrage und Antwort.

System

Ist der Dienst wach, ist er angemeldet, und wann hat er zuletzt mit dem Server gesprochen. GET /api/v1/sync beantwortet, was der letzte Abgleich getan hat, ohne einen neuen auszuführen; POST führt einen aus.

Pfad	Methoden
/api/v1/status	GET
/api/v1/sync	GET, POST
/api/v1/token	POST

/health und /api/v1/health existieren ebenfalls, außerhalb der dokumentierten Menge.

Identität

Die zwei Routen, die eine Integration meistens will.

POST /api/v1/verify prüft drei Wörter gegen die Verbindungen, für die dieses Gerät ein Geheimnis hält. Das läuft rein lokal ab. Lies das Feld conclusive, bevor du irgendetwas anzeigst: Es ist falsch, sobald eine Verbindung nicht geprüft werden konnte, einschließlich des häufigen Falls, dass nichts zwischengespeichert ist. Ein aufrufendes Programm darf “nicht verifiziert” nur sagen, wenn conclusive wahr ist.

Ein Treffer trägt window — current, oder previous für einen früheren Code, den der Betreiber noch annimmt (standardmäßig einer), wobei windowsBack angibt, wie weit zurück — und validUntil, den Zeitpunkt, an dem dieser Code aufhört oder aufgehört hat zu gelten. Zeig einen vorherigen Treffer mit dieser Zeit in Ortszeit und schlag für eine Nachricht, die später gelesen wird, ein Siegel vor. Bei einer Verbindung, in der jedes Mitglied einen eigenen Code hat, sagt memberName, wessen Code es war. Der eigene Code des Lesers passt nie. Diese Route und die vorherigen Codes unten brauchen nur ein Token mit Leserechten.

POST /api/v1/stamp signiert Inhalt auf dem Gerät und antwortet mit drei Wörtern, dem Zeitpunkt der Signatur, einer Vertrauensstufe und der URL, die eine empfangende Person öffnet, um die Signatur zu prüfen.

Pfad	Methoden
/api/v1/stamp	POST
/api/v1/verify	POST

Vertrauen

Personen folgen, und das Verzeichnis der Verifizierungen.

POST /api/v1/verify/public ist die andere Hälfte von /api/v1/verify: Sie fragt den Server, ob drei Wörter irgendjemandem gehören, statt lokal zu prüfen.

Die Routen unter /api/v1/trust-cards zeigen und ändern die Personen, denen dieses Konto folgt. Der Pfad trägt einen älteren Namen. Die {id} auf diesen Routen ist die Kennung der gefolgten Person, nicht die der Zeile.

Pfad	Methoden
/api/v1/trust-cards	GET, POST
/api/v1/trust-cards/{id}	PATCH, DELETE
/api/v1/trust-cards/{id}/history	GET
/api/v1/trust/metrics	GET
/api/v1/verification-log	GET
/api/v1/verify/public	POST

Verbindungen

Verbindungen anlegen, lesen, umbenennen und löschen; den aktuellen Code für eine lesen; eine als Favorit markieren; Mitglieder hinzufügen und entfernen.

GET /api/v1/connections/:id/members/:mid/previous-codes listet die vorherigen Codes eines Mitglieds auf, den neuesten zuerst, jeweils mit words, validFrom und validUntil; :mid ist die ID der Mitgliedszeile. previousWindows ist die Anzahl, die der Betreiber annimmt. available ist falsch, wenn dieses Gerät kein Geheimnis hält, aus dem sich die Codes ableiten ließen — zeig das als “kann nicht angezeigt werden”, nicht als leere Liste. Das läuft lokal und speichert nichts. Eine Zeile, die kein Mitglied dieser Verbindung ist, ergibt 404.

Pfad	Methoden
/api/v1/connections	GET, POST
/api/v1/connections/:id	GET, PATCH, DELETE
/api/v1/connections/:id/code	GET
/api/v1/connections/:id/favorite	POST
/api/v1/connections/:id/members	POST
/api/v1/connections/:id/members/:mid	DELETE
/api/v1/connections/:id/members/:mid/previous-codes	GET

Einladungen

GET /api/v1/invitations listet beide Richtungen auf. Der Rest wirkt auf eine einzelne Einladung: eine annehmen, ablehnen oder eine gesendete zurückziehen.

Pfad	Methoden
/api/v1/invitations	GET
/api/v1/invitations/pending	GET
/api/v1/invitations/:id/approve	POST
/api/v1/invitations/:id/decline	POST
/api/v1/invitations/:id/withdraw	POST

Gastcodes

Codes für Personen anlegen und widerrufen, die die App nicht nutzen, einen als QR-Bild abrufen oder ihn versenden lassen.

Pfad	Methoden
/api/v1/guest-codes	GET, POST
/api/v1/guest-codes/:id	DELETE
/api/v1/guest-codes/:id/qr	GET
/api/v1/guest-codes/:id/send	POST

Externe Mitglieder

Die Seiten zur Gastverifizierung.

Pfad	Methoden
/api/v1/external-members	GET, POST
/api/v1/external-members/:id	DELETE

Etiketten

Etiketten ordnen Verbindungen. Der Zuweisungspfad nimmt beide Kennungen entgegen: erst das Etikett, dann die Verbindung.

Pfad	Methoden
/api/v1/tags	GET, POST
/api/v1/tags/:id	PATCH, DELETE
/api/v1/tags/:id/assign/:cid	POST, DELETE

Vorlagen

Verbindungsvorlagen, und welche davon die Vorgabe ist.

Pfad	Methoden
/api/v1/presets	GET, POST
/api/v1/presets/{id}	PATCH, DELETE
/api/v1/presets/{id}/default	POST
/api/v1/presets/default	DELETE

Offene Links

Offene Links und die Anfragen, die sie erzeugen. Ein Link lässt sich anhalten, wieder freigeben oder mit einer neuen Kurzadresse versehen; eine Anfrage lässt sich genehmigen oder ablehnen. suggest schlägt eine Kurzadresse vor.

Pfad	Methoden
/api/v1/open-links	GET, POST
/api/v1/open-links/suggest	GET
/api/v1/open-links/{id}	DELETE
/api/v1/open-links/{id}/pause	PATCH
/api/v1/open-links/{id}/resume	PATCH
/api/v1/open-links/{id}/slug	PATCH
/api/v1/open-links/requests	GET
/api/v1/open-links/requests/{id}/approve	POST
/api/v1/open-links/requests/{id}/decline	POST

Profil und Kontext

GET /api/v1/context beantwortet Kontoidentität und Organisationskontext in einem Aufruf — der aktive Organisationskontext ist nur vorhanden, wenn es einen gibt.

POST /api/v1/context/active-org wechselt die aktive Organisation oder löscht sie für den persönlichen Kontext. Das gilt nur für diese Sitzung: Es schreibt die Wahl dieser Sitzung, nicht die dauerhafte Vorgabe des Nutzers, sodass eine Wahl auf dem Desktop keine anderen Geräte umlenkt.

/api/v1/profiles/{id} ist ein minimales öffentliches Profil von jemand anderem, und /keys dessen aktive öffentliche Schlüssel.

Pfad	Methoden
/api/v1/context	GET
/api/v1/context/active-org	POST
/api/v1/profile	GET, PATCH
/api/v1/profiles/{id}	GET
/api/v1/profiles/{id}/keys	GET
/api/v1/preferences	GET, PATCH
/api/v1/notifications	GET, DELETE
/api/v1/notifications/read	POST

Konto

Geräte, Sitzungen, E-Mail-Adressen, Datenauskünfte und Kontolöschung.

Eine Auskunft wird angefordert und vom Server erstellt: POST /api/v1/exports antwortet mit einer Kennung, nicht mit einer Datei, und /api/v1/exports/{id}/download antwortet mit einem signierten, ablaufenden Link zu einer fertigen Auskunft.

DELETE /api/v1/account löscht das Konto und alles darin, unwiderruflich. Es verlangt einen Rumpf mit confirmEmail, der eigenen Adresse des Kontos, die der Dienst auf der Maschine vergleicht, bevor er irgendetwas aufruft. Ein Aufruf ohne Rumpf, oder mit der falschen Adresse, wird abgewiesen.

Pfad	Methoden
/api/v1/devices	GET
/api/v1/devices/{id}	DELETE
/api/v1/sessions	GET
/api/v1/sessions/{id}	DELETE
/api/v1/emails	GET, POST
/api/v1/exports	GET, POST, DELETE
/api/v1/exports/{id}/download	GET
/api/v1/account	DELETE

Organisationsverwaltung

Mitglieder, Gruppen, Alarme und Analytics.

Die Routen für Mitglieder, Gruppen und Alarme brauchen bei jeder Methode ein full-Token. Die Lesezugriffe für Aktivität und Analytics sind gewöhnliche GETs, bei denen ein read-Token reicht.

Pfad	Methoden
/api/v1/org/members	GET
/api/v1/org/members/{id}	GET
/api/v1/org/members/{id}/activate	POST
/api/v1/org/members/{id}/suspend	POST
/api/v1/org/members/bulk-invite	POST
/api/v1/org/groups	GET, POST
/api/v1/org/groups/{id}	PATCH, DELETE
/api/v1/org/groups/{id}/members	POST, DELETE
/api/v1/org/alerts	GET, POST
/api/v1/org/alerts/{id}	PATCH, DELETE
/api/v1/org/activity	GET
/api/v1/org/activity/summary	GET
/api/v1/org/analytics/dashboard	GET
/api/v1/org/analytics/trends	GET

API-Token

Token auflisten, prägen und widerrufen. Ebenfalls nur full.

Pfad	Methoden
/api/v1/api-tokens	GET, POST
/api/v1/api-tokens/{id}	DELETE

Assistent und Rückmeldung

Eine Runde des Assistentengesprächs, eine Bewertung für eine Antwort, und Rückmeldung an das Team. Die Chat-Antwort wird vom Server unverändert durchgereicht, der Dienst korrigiert ihre Form nicht.

Pfad	Methoden
/api/v1/chat	POST
/api/v1/chat/rate	POST
/api/v1/feedback	POST