API.
La aplicación web y de escritorio se comunica con la API HTTP de Hikarune en https://chat.hikarune.online/api. Esta página describe las rutas del servidor incluidas en el proyecto.
Sesiones y autenticación
La aplicación inicia sesión mediante POST /api/auth/login. El servidor crea una sesión y la mantiene en una cookie protegida HttpOnly; las rutas privadas requieren esa sesión.
No hay claves de integración ni credenciales de tipo token publicadas en el proyecto. No compartas la cookie de sesión. Para cerrar la sesión, la aplicación envía POST /api/auth/logout.
Rutas principales
Los parámetros entre llaves son identificadores numéricos. La autenticación y los permisos requeridos dependen de cada ruta.
| Método | Ruta | Descripción |
|---|---|---|
| GET | /api/config | Configuración pública y modo de registro de la instancia. |
| GET | /api/health | Comprobación de disponibilidad del servidor. |
| POST | /api/auth/register | Registro sujeto al modo de acceso configurado y, si corresponde, a una invitación. |
| POST | /api/auth/login | Inicia sesión y establece la cookie de sesión. |
| POST | /api/auth/logout | Invalida la sesión actual. |
| GET | /api/me | Consulta el perfil de la cuenta autenticada. |
| PATCH | /api/me | Actualiza los datos editables del perfil. |
| GET | /api/me/bits | Consulta saldo, movimientos y artículos de Bits. |
| POST | /api/me/bits/redeem | Canjea un código válido de Bits. |
| POST | /api/me/bits/buy | Compra un artículo de perfil con Bits. |
| POST | /api/spaces/{sid}/tip | Envía Bits a otro miembro de una comunidad compartida. |
| GET | /api/channels/{cid}/messages | Consulta mensajes de un canal accesible. |
| POST | /api/channels/{cid}/messages | Publica un mensaje en un canal accesible. |
| PATCH | /api/messages/{mid} | Edita un mensaje si la cuenta tiene permiso. |
| DELETE | /api/messages/{mid} | Elimina un mensaje si la cuenta tiene permiso. |
| PUT / DELETE | /api/messages/{mid}/reactions/{emoji} | Añade o quita una reacción. |
Formato de respuesta
Las rutas intercambian JSON, salvo las operaciones de subida de archivos. Por ejemplo, la consulta del saldo devuelve un objeto con el balance, los movimientos y los artículos disponibles:
El valor de la tienda y el contenido de cada respuesta dependen de la configuración de la instancia y de la cuenta autenticada.
Errores y límites
El servidor valida los datos, la sesión, los permisos y los límites de frecuencia. Algunos límites, como los de registro y mensajes, se configuran en cada instancia.
| Código | Significado |
|---|---|
400 | Datos no válidos o petición incompleta. |
401 | Falta una sesión válida. |
403 | La cuenta no tiene permiso para la operación. |
404 | Recurso inexistente o no disponible para la cuenta. |
413 | El archivo supera el límite configurado. |
429 | Se ha superado un límite de frecuencia; espera antes de reintentar. |
Esta referencia describe la API que utiliza el cliente Hikarune. El proyecto no publica una API versionada ni un contrato de compatibilidad para integraciones de terceros.