Routekaart

Elk pad hieronder valt onder http://127.0.0.1:19821 en komt uit het eigen OpenAPI-document van de daemon. Alleen /api/v1/token in de eerste groep is bereikbaar zonder bearer-token.

Waar het document geen beschrijving voor een route draagt, wordt hier niets verzonnen. Haal /api/v1/openapi.json op, of open /api/v1/docs, voor request- en responseschema’s.

Systeem

Is de daemon actief, is hij aangemeld, en wanneer heeft hij voor het laatst met de server gesproken. GET /api/v1/sync antwoordt wat de laatste synchronisatie deed zonder er nog een uit te voeren; POST voert er een uit.

Path	Methods
/api/v1/status	GET
/api/v1/sync	GET, POST
/api/v1/token	POST

/health en /api/v1/health bestaan ook, buiten de gedocumenteerde set.

Identiteit

De twee routes die een integratie meestal wil.

POST /api/v1/verify controleert drie woorden tegen de verbindingen waarvoor dit apparaat een geheim bezit. Het is puur lokaal. Lees het veld conclusive voordat je iets toont: het is false zodra een verbinding niet gecontroleerd kon worden, inclusief het gewone geval waarin niets gecachet is. Een aanroeper mag pas “niet geverifieerd” zeggen als conclusive true is.

Een match bevat window — current, of previous voor een eerdere code die de operator nog accepteert (standaard één), waarbij windowsBack zegt hoe ver terug — en validUntil, het moment waarop die code niet meer geldt of gold. Toon een vorige match met die tijd in lokale tijd en stel voor een bericht dat later wordt gelezen een zegel voor. Bij een verbinding waarin elk lid een eigen code heeft, zegt memberName van wie de code was. De eigen code van de lezer komt nooit overeen. Deze route en de vorige codes hieronder hebben alleen een token met leesrechten nodig.

POST /api/v1/stamp ondertekent content op het apparaat en antwoordt met drie woorden, het tijdstip van ondertekening, een betrouwbaarheidsniveau en de URL waar een ontvanger de handtekening kan controleren.

Path	Methods
/api/v1/stamp	POST
/api/v1/verify	POST

Vertrouwen

Mensen volgen, en het overzicht van verificaties.

POST /api/v1/verify/public is de andere helft van /api/v1/verify: hij vraagt de server of drie woorden bij iemand horen, in plaats van lokaal te controleren.

De routes /api/v1/trust-cards tonen en wijzigen de mensen die dit account volgt. Het pad heeft een oudere naam. De {id} op deze routes is het id van de gevolgde persoon, niet het id van de volgrij.

Path	Methods
/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

Verbindingen

Verbindingen aanmaken, lezen, hernoemen en verwijderen; de huidige code voor een verbinding lezen; er een als favoriet markeren; leden toevoegen en verwijderen.

GET /api/v1/connections/:id/members/:mid/previous-codes somt de vorige codes van één lid op, de nieuwste eerst, elk met words, validFrom en validUntil; :mid is het id van de lidmaatschapsrij. previousWindows is hoeveel de operator er accepteert. available is false als dit apparaat geen geheim heeft om ze uit af te leiden — toon dat als “kan niet worden getoond”, niet als een lege lijst. Het is lokaal en legt niets vast. Een rij die geen lid van die verbinding is, geeft 404.

Path	Methods
/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

Uitnodigingen

GET /api/v1/invitations somt beide richtingen op. De rest handelt op één uitnodiging: goedkeuren, afwijzen, of er een intrekken die je zelf verstuurde.

Path	Methods
/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 aanmaken en intrekken voor mensen die de app niet gebruiken, er een als QR-afbeelding ophalen, of laten versturen.

Path	Methods
/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 leden

De pagina’s voor gastverificatie.

Path	Methods
/api/v1/external-members	GET, POST
/api/v1/external-members/:id	DELETE

Tags

Tags organiseren verbindingen. Het toewijzingspad neemt beide id’s: eerst de tag, dan de verbinding.

Path	Methods
/api/v1/tags	GET, POST
/api/v1/tags/:id	PATCH, DELETE
/api/v1/tags/:id/assign/:cid	POST, DELETE

Voorinstellingen

Verbindingspresets, en welke daarvan de standaard is.

Path	Methods
/api/v1/presets	GET, POST
/api/v1/presets/{id}	PATCH, DELETE
/api/v1/presets/{id}/default	POST
/api/v1/presets/default	DELETE

Open links

Open links en de goedkeuringsverzoeken die ze opleveren. Een link kan worden gepauzeerd, hervat of van een nieuwe slug voorzien; een verzoek kan worden goedgekeurd of afgewezen. suggest stelt een slug voor.

Path	Methods
/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

Profiel en context

GET /api/v1/context beantwoordt accountidentiteit en organisatiecontext in één aanroep — de actieve organisatie is alleen aanwezig als er een is.

POST /api/v1/context/active-org wisselt de actieve organisatie, of wist die voor persoonlijke context. Het is sessiegebonden: het schrijft de keuze van deze sessie, niet de blijvende gebruikersstandaard, dus een keuze op de desktop stuurt geen andere apparaten om.

/api/v1/profiles/{id} is een minimaal openbaar profiel van iemand anders, en /keys diens actieve publieke sleutels.

Path	Methods
/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

Account

Apparaten, sessies, e-mailadressen, gegevensexports en accountverwijdering.

Een export wordt aangevraagd en door de server samengesteld: POST /api/v1/exports antwoordt met een id, geen bestand, en /api/v1/exports/{id}/download antwoordt met een ondertekende, verlopende link naar een afgeronde export.

DELETE /api/v1/account verwijdert het account en alles erin, en kan niet ongedaan worden gemaakt. Het vereist een body met confirmEmail, het eigen adres van het account, dat de daemon op de machine zelf vergelijkt voordat hij iets aanroept. Een aanroep zonder body, of met het verkeerde adres, wordt geweigerd.

Path	Methods
/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

Organisatiebeheer

Leden, groepen, meldingen en analyse.

De routes voor leden, groepen en meldingen vereisen een full-token, op elke methode. De leesroutes voor activiteit en analyse zijn gewone GET’s en een read-token volstaat.

Path	Methods
/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-tokens

Tokens opsommen, aanmaken en intrekken. Ook alleen full.

Path	Methods
/api/v1/api-tokens	GET, POST
/api/v1/api-tokens/{id}	DELETE

Assistent en feedback

Eén beurt van het assistentgesprek, een beoordeling voor een antwoord, en feedback aan het team. Het chatantwoord wordt ongewijzigd van de server doorgegeven, dus de daemon past de vorm ervan niet aan.

Path	Methods
/api/v1/chat	POST
/api/v1/chat/rate	POST
/api/v1/feedback	POST