Mapa de rutas
Cada ruta de abajo está bajo http://127.0.0.1:19821 y viene del propio
documento OpenAPI del daemon. Solo /api/v1/token del primer grupo es
alcanzable sin token portador.
Donde el documento no lleva descripción para una ruta, no se inventa ninguna
aquí. Obtén /api/v1/openapi.json, o abre /api/v1/docs, para los esquemas de
solicitud y respuesta.
Sistema
Sección titulada «Sistema»Si el daemon está activo, si ha iniciado sesión, y cuándo habló por última vez
con el servidor. GET /api/v1/sync responde qué hizo la última sincronización
sin hacer otra; POST ejecuta una.
| Ruta | Métodos |
|---|---|
/api/v1/status | GET |
/api/v1/sync | GET, POST |
/api/v1/token | POST |
/health y /api/v1/health también existen, fuera del conjunto documentado.
Identidad
Sección titulada «Identidad»Las dos rutas que una integración suele querer.
POST /api/v1/verify comprueba tres palabras contra las conexiones para las que
este dispositivo guarda un secreto. Es puramente local. Lee el campo
conclusive antes de mostrar nada: es false siempre que alguna conexión no se
pudo comprobar, incluido el caso habitual en el que no hay nada en caché. Quien
llama no debe decir «no verificado» a menos que conclusive sea true.
Una coincidencia lleva window — current, o previous para un código
anterior que el operador aún acepta (uno por defecto), con windowsBack
indicando cuánto hacia atrás — y validUntil, el instante en que ese código
deja o dejó de ser válido. Muestra una coincidencia anterior con esa hora en
hora local y sugiere un sello para un mensaje que se lee más tarde. En una
conexión donde cada miembro tiene su propio código, memberName dice de quién
era. El propio código de quien lee nunca coincide. Esta ruta y los códigos
anteriores de abajo solo necesitan un token de lectura.
POST /api/v1/stamp firma contenido en el dispositivo y responde tres palabras,
la hora en la que se firmó, un nivel de garantía y la URL que abre quien recibe
para comprobar la firma.
| Ruta | Métodos |
|---|---|
/api/v1/stamp | POST |
/api/v1/verify | POST |
Confianza
Sección titulada «Confianza»Seguir a personas, y el registro de verificaciones.
POST /api/v1/verify/public es la otra mitad de /api/v1/verify: le pregunta
al servidor si tres palabras pertenecen a alguien, en lugar de comprobarlo en
local.
Las rutas /api/v1/trust-cards listan y modifican a las personas que sigue esta
cuenta. La ruta conserva un nombre anterior. El {id} de estas rutas es el id
de la persona seguida, no el de la fila de seguimiento.
| Ruta | Métodos |
|---|---|
/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 |
Conexiones
Sección titulada «Conexiones»Crear, leer, renombrar y eliminar conexiones; leer el código actual de una; marcar una como favorita; añadir y quitar miembros.
GET /api/v1/connections/:id/members/:mid/previous-codes lista los códigos
anteriores de un miembro, el más reciente primero, cada uno con words,
validFrom y validUntil; :mid es el id de la fila de membresía.
previousWindows es cuántos acepta el operador. available es false cuando
este dispositivo no guarda ningún secreto del que derivarlos — muéstralo como
«no se puede mostrar», no como una lista vacía. Es local y no registra nada. Una
fila que no es miembro de esa conexión responde 404.
| Ruta | Métodos |
|---|---|
/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 |
Invitaciones
Sección titulada «Invitaciones»GET /api/v1/invitations lista ambas direcciones. El resto actúa sobre una
invitación: aprobar, rechazar o retirar una que enviaste.
| Ruta | Métodos |
|---|---|
/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 |
Códigos de invitado
Sección titulada «Códigos de invitado»Crear y revocar códigos para personas que no usan la app, obtener uno como imagen QR, o hacer que se envíe.
| Ruta | Métodos |
|---|---|
/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 |
Miembros externos
Sección titulada «Miembros externos»Las páginas de verificación de invitados.
| Ruta | Métodos |
|---|---|
/api/v1/external-members | GET, POST |
/api/v1/external-members/:id | DELETE |
Etiquetas
Sección titulada «Etiquetas»Las etiquetas organizan conexiones. La ruta de asignación toma ambos id: el de la etiqueta, y luego el de la conexión.
| Ruta | Métodos |
|---|---|
/api/v1/tags | GET, POST |
/api/v1/tags/:id | PATCH, DELETE |
/api/v1/tags/:id/assign/:cid | POST, DELETE |
Plantillas
Sección titulada «Plantillas»Plantillas de conexión, y cuál es la de por defecto.
| Ruta | Métodos |
|---|---|
/api/v1/presets | GET, POST |
/api/v1/presets/{id} | PATCH, DELETE |
/api/v1/presets/{id}/default | POST |
/api/v1/presets/default | DELETE |
Enlaces abiertos
Sección titulada «Enlaces abiertos»Enlaces abiertos y las solicitudes de aprobación que producen. Un enlace se
puede pausar, reanudar o darle un slug nuevo; una solicitud se puede aprobar o
rechazar. suggest propone un slug.
| Ruta | Métodos |
|---|---|
/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 |
Perfil y contexto
Sección titulada «Perfil y contexto»GET /api/v1/context responde la identidad de la cuenta y el contexto de
organización en una sola llamada — la organización activa solo está presente
cuando hay una.
POST /api/v1/context/active-org cambia la organización activa, o la borra para
el contexto personal. Está limitado a la sesión: escribe la elección de esta
sesión, no el valor por defecto persistente del usuario, así que una elección en
el escritorio no reapunta a otros dispositivos.
/api/v1/profiles/{id} es un perfil público mínimo de otra persona, y /keys
sus claves públicas activas.
| Ruta | Métodos |
|---|---|
/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 |
Dispositivos, sesiones, direcciones de correo, exportaciones de datos y eliminación de cuenta.
Una exportación se pide y la construye el servidor: POST /api/v1/exports
responde un id, no un archivo, y /api/v1/exports/{id}/download responde un
enlace firmado y con caducidad a una ya terminada.
DELETE /api/v1/account elimina la cuenta y todo lo que contiene, y no se puede
deshacer. Exige un cuerpo que lleve confirmEmail, la dirección propia de la
cuenta, que el daemon compara en la máquina antes de llamar a nada. Una llamada
sin cuerpo, o con la dirección equivocada, se rechaza.
| Ruta | Métodos |
|---|---|
/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 |
Administración de organización
Sección titulada «Administración de organización»Miembros, grupos, alertas y analítica.
Las rutas de miembros, grupos y alertas necesitan un token full, en cada
método. Las lecturas de actividad y analítica son GET normales y basta un
token read.
| Ruta | Métodos |
|---|---|
/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 |
Tokens de API
Sección titulada «Tokens de API»Listar, emitir y revocar tokens. También solo full.
| Ruta | Métodos |
|---|---|
/api/v1/api-tokens | GET, POST |
/api/v1/api-tokens/{id} | DELETE |
Asistente y comentarios
Sección titulada «Asistente y comentarios»Un turno de la conversación con el asistente, una valoración para una respuesta, y comentarios al equipo. La respuesta del chat se pasa tal cual desde el servidor, así que el daemon no fija su forma.
| Ruta | Métodos |
|---|---|
/api/v1/chat | POST |
/api/v1/chat/rate | POST |
/api/v1/feedback | POST |