Cada instalación de RaxBoard incluye una REST API autenticada con Bearer. Emite claves con ámbitos y lee y escribe foros, temas, mensajes, miembros, mensajes privados y moderación — todo por HTTP.
Un documento OpenAPI 3.1 legible por máquina describe cada endpoint, ámbito y esquema. Apunta Swagger UI, Postman o un generador de SDK a la especificación de tu foro, o explórala de forma interactiva abajo.
Envía tu clave como token Bearer en la cabecera Authorization. Todos los endpoints bajo /api/v1 la requieren; las peticiones sin una clave válida devuelven 401.
Las claves se crean dentro de tu foro, nunca en raxboard.com:
Cada clave lleva uno o más ámbitos. Los ámbitos amplios (read, write, admin) incluyen sus miembros más específicos; los mensajes privados y las acciones de administración requieren su ámbito explícito.
| Ámbito | Nombre | Descripción |
|---|---|---|
| * | Acceso total | Todo lo de abajo. Concédelo solo a integraciones de plena confianza. |
| read | Lectura | Leer foros, temas, mensajes y usuarios públicos. |
| write | Escritura | Todas las acciones de escritura no administrativas (mensaje, tema, reacción, edición). |
| thread:write | Crear temas | Abrir nuevos temas. |
| post:write | Crear mensajes | Responder a temas. |
| post:manage | Gestionar mensajes | Editar y eliminar mensajes. |
| react:write | Reaccionar | Añadir o quitar reacciones. |
| conversation:read | Leer mensajes | Leer las conversaciones privadas del propietario. |
| conversation:write | Enviar mensajes | Iniciar y responder conversaciones privadas. |
| token | Gestionar claves API | Listar y revocar tus propias claves API. |
| admin | Administración | Todas las acciones administrativas de abajo. |
| admin:users | Gestionar usuarios | Banear, desbanear y gestionar cuentas de miembros. |
| admin:content | Moderar contenido | Moderar temas y mensajes. |
Cada clave tiene un límite de peticiones por minuto (60 por defecto). Las respuestas llevan cabeceras de límite; superarlo devuelve HTTP 429 con Retry-After.
Las respuestas correctas se envuelven en { success: true, data: ... }. Los errores devuelven un envoltorio coherente con un código legible por máquina y un mensaje humano, más el estado HTTP adecuado.
Los endpoints de listas aceptan page y per_page (máx. 100). La respuesta lleva un objeto pagination y una cabecera Link RFC 5988 con URLs first/prev/next/last.
/api/v1read/api/v1/authread/api/v1/forumsread/api/v1/forums/{id}read/api/v1/threadsread/api/v1/threadsthread:write/api/v1/threads/{id}read/api/v1/threads/{id}/postsread/api/v1/postsread/api/v1/postspost:write/api/v1/posts/{id}read/api/v1/posts/{id}post:manage/api/v1/posts/{id}post:manage/api/v1/posts/{id}/reactreact:write/api/v1/usersread/api/v1/users/meread/api/v1/users/{id}read/api/v1/notifications/alertsread/api/v1/searchread/api/v1/messagesconversation:read/api/v1/messagesconversation:write/api/v1/messages/{id}conversation:read/api/v1/messages/{id}/replyconversation:write/api/v1/admin/users/{id}/banadmin:users/api/v1/admin/users/{id}/unbanadmin:users/api/v1/admin/threads/{id}/deleteadmin:content/api/v1/admin/threads/{id}/restoreadmin:content/api/v1/admin/posts/{id}/deleteadmin:content/api/v1/admin/posts/{id}/approveadmin:content/api/v1/notifications/alerts/{id}/readwrite/api/v1/notifications/alerts/read-allwrite/api/v1/notifications/alerts/countread/api/v1/reactionsread/api/v1/posts/{id}/reactreact:write/api/v1/threads/{id}/bookmarkwrite/api/v1/posts/{id}/bookmarkwrite/api/v1/users/me/bookmarksread/api/v1/users/me/bookmarks/labelsread/api/v1/users/{id}/followwrite/api/v1/users/{id}/followwrite/api/v1/users/{id}/followersread/api/v1/users/{id}/followingread/api/v1/users/{id}/wallread/api/v1/users/{id}/wallwrite/api/v1/users/{id}/ignorewrite/api/v1/users/{id}/ignorewrite/api/v1/users/{id}/blockwrite/api/v1/users/{id}/blockwrite/api/v1/threads/{id}/watchwrite/api/v1/threads/{id}/watchwrite/api/v1/forums/{id}/readwrite/api/v1/forums/read-allwrite/api/v1/tagsread/api/v1/tags/{slug}/threadsread/api/v1/forums/{id}/prefixesread/api/v1/polls/{id}read/api/v1/polls/{id}/votewrite/api/v1/polls/{id}/votewrite/api/v1/threads/{id}/reportwrite/api/v1/posts/{id}/reportwrite/api/v1/admin/reportsadmin:content/api/v1/admin/reports/{id}/resolveadmin:content/api/v1/attachmentswrite/api/v1/attachments/{id}read/api/v1/users/mewrite/api/v1/users/me/preferencesread/api/v1/users/me/preferenceswrite/api/v1/users/me/custom-fields/{field_id}write/api/v1/users/me/ignoredread/api/v1/users/me/tokenstoken/api/v1/users/me/tokens/{id}token/api/v1/users/onlineread/api/v1/user-groupsread/api/v1/user-groups/{id}/membersread/api/v1/nodesread/api/v1/statsread/api/v1/eventsread/api/v1/events/{id}/rsvpwrite/api/v1/clubsread/api/v1/clubs/{id}/joinwrite/api/v1/users/me/drafts/{key}read/api/v1/users/me/drafts/{key}write/api/v1/broadcast/authread/api/v1/broadcast/pollread/api/v1/presence/thread/{thread_id}read/api/v1/presence/onlineread/api/v1/push/subscribereadReemplaza your-forum.com por tu propio dominio y YOUR_API_KEY por una clave que hayas creado.
Además de la REST API, tu foro puede enviar webhooks firmados con HMAC a servicios externos cuando ocurren eventos — configúralos en Panel de administración → Webhooks.
Esta referencia se aplica a la API de tu propia instalación de RaxBoard. Volver a la documentación →