Ir al contenido

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.

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.

RutaMétodos
/api/v1/statusGET
/api/v1/syncGET, POST
/api/v1/tokenPOST

/health y /api/v1/health también existen, fuera del conjunto documentado.

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.

RutaMétodos
/api/v1/stampPOST
/api/v1/verifyPOST

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.

RutaMétodos
/api/v1/trust-cardsGET, POST
/api/v1/trust-cards/{id}PATCH, DELETE
/api/v1/trust-cards/{id}/historyGET
/api/v1/trust/metricsGET
/api/v1/verification-logGET
/api/v1/verify/publicPOST

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.

RutaMétodos
/api/v1/connectionsGET, POST
/api/v1/connections/:idGET, PATCH, DELETE
/api/v1/connections/:id/codeGET
/api/v1/connections/:id/favoritePOST
/api/v1/connections/:id/membersPOST
/api/v1/connections/:id/members/:midDELETE
/api/v1/connections/:id/members/:mid/previous-codesGET

GET /api/v1/invitations lista ambas direcciones. El resto actúa sobre una invitación: aprobar, rechazar o retirar una que enviaste.

RutaMétodos
/api/v1/invitationsGET
/api/v1/invitations/pendingGET
/api/v1/invitations/:id/approvePOST
/api/v1/invitations/:id/declinePOST
/api/v1/invitations/:id/withdrawPOST

Crear y revocar códigos para personas que no usan la app, obtener uno como imagen QR, o hacer que se envíe.

RutaMétodos
/api/v1/guest-codesGET, POST
/api/v1/guest-codes/:idDELETE
/api/v1/guest-codes/:id/qrGET
/api/v1/guest-codes/:id/sendPOST

Las páginas de verificación de invitados.

RutaMétodos
/api/v1/external-membersGET, POST
/api/v1/external-members/:idDELETE

Las etiquetas organizan conexiones. La ruta de asignación toma ambos id: el de la etiqueta, y luego el de la conexión.

RutaMétodos
/api/v1/tagsGET, POST
/api/v1/tags/:idPATCH, DELETE
/api/v1/tags/:id/assign/:cidPOST, DELETE

Plantillas de conexión, y cuál es la de por defecto.

RutaMétodos
/api/v1/presetsGET, POST
/api/v1/presets/{id}PATCH, DELETE
/api/v1/presets/{id}/defaultPOST
/api/v1/presets/defaultDELETE

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.

RutaMétodos
/api/v1/open-linksGET, POST
/api/v1/open-links/suggestGET
/api/v1/open-links/{id}DELETE
/api/v1/open-links/{id}/pausePATCH
/api/v1/open-links/{id}/resumePATCH
/api/v1/open-links/{id}/slugPATCH
/api/v1/open-links/requestsGET
/api/v1/open-links/requests/{id}/approvePOST
/api/v1/open-links/requests/{id}/declinePOST

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.

RutaMétodos
/api/v1/contextGET
/api/v1/context/active-orgPOST
/api/v1/profileGET, PATCH
/api/v1/profiles/{id}GET
/api/v1/profiles/{id}/keysGET
/api/v1/preferencesGET, PATCH
/api/v1/notificationsGET, DELETE
/api/v1/notifications/readPOST

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.

RutaMétodos
/api/v1/devicesGET
/api/v1/devices/{id}DELETE
/api/v1/sessionsGET
/api/v1/sessions/{id}DELETE
/api/v1/emailsGET, POST
/api/v1/exportsGET, POST, DELETE
/api/v1/exports/{id}/downloadGET
/api/v1/accountDELETE

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.

RutaMétodos
/api/v1/org/membersGET
/api/v1/org/members/{id}GET
/api/v1/org/members/{id}/activatePOST
/api/v1/org/members/{id}/suspendPOST
/api/v1/org/members/bulk-invitePOST
/api/v1/org/groupsGET, POST
/api/v1/org/groups/{id}PATCH, DELETE
/api/v1/org/groups/{id}/membersPOST, DELETE
/api/v1/org/alertsGET, POST
/api/v1/org/alerts/{id}PATCH, DELETE
/api/v1/org/activityGET
/api/v1/org/activity/summaryGET
/api/v1/org/analytics/dashboardGET
/api/v1/org/analytics/trendsGET

Listar, emitir y revocar tokens. También solo full.

RutaMétodos
/api/v1/api-tokensGET, POST
/api/v1/api-tokens/{id}DELETE

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.

RutaMétodos
/api/v1/chatPOST
/api/v1/chat/ratePOST
/api/v1/feedbackPOST