Las capturas de pantalla muestran la interfaz en inglés.
Todas las operaciones se aplican al propietario de la clave. Un cuerpo JSON no puede seleccionar la bandeja de entrada o las preferencias de otro usuario. notifications:read lee la bandeja de entrada; notifications:write cambia el estado de lectura y elimina las notificaciones de lectura. Las listas utilizan state=all, read o unread, con parámetros de cursor. PATCH envíe el valor booleano read con un ETag; read-all marca como leída toda la bandeja de entrada del propietario. Un UUID extranjero/desaparecido no revela ningún contenido; el GET actual devuelve 422 notification_validation_failed para ese caso.
follows:read/follows:write gestiona los seguimientos personales. Los tipos son workspace, page, calendar, task_list. El target_id de una página es su ID de nodo del espacio de trabajo numérico, no la clave del documento HTML. Las listas de tareas también requieren document_id. Se vuelve a comprobar el acceso actual al objetivo. Seguir un calendario y suscribirse a él son diferentes: eliminar un seguimiento desactiva las notificaciones sin eliminar la suscripción al calendario.
Las preferencias personales incluyen email_enabled, email_mode (immediate, daily, important, off), notify_own_changes, theme_mode (auto, light, dark, system). La elección del tema se aplica sólo cuando la política global permite un modo personal. Un seguimiento puede tener email_mode_override; null hereda las preferencias. GET personal-workspace requiere workspace:read y devuelve el estado; no crea un espacio de trabajo.
Operaciones y ejemplos verificados.
GET /api/v1/notifications
Propósito: Devuelve una bandeja de entrada paginada con un filtro state=all|read|unread opcional.
Permiso: notifications:read. Solo las notificaciones del propietario de la clave.
Parámetros de consulta: page[after], page[limit], state.
Cuerpo: sin campos de entrada adicionales; sigue el ejemplo.
curl --globoff --silent --show-error \
--request GET \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
"$BASE_URL/api/v1/notifications?page[limit]=1&state=all"
Respuesta real: HTTP 200.
{
"data": [
{
"id": 1,
"uuid": "0f2851e0-660d-4f78-b8bc-c356d3ff1d9c",
"user_id": 1,
"notification_key": "api.manual.example",
"title": "API workshop reminder",
"message": "Review the API example before the workshop.",
"link_url": "/about",
"source_module": "application",
"source_reference": "api-manual",
"dedup_key": "api-manual-notification",
"data_json": null,
"read_at": null,
"created_at": "2026-11-06 22:48:09",
"updated_at": "2026-11-06 22:48:09",
"is_read": false,
"data": []
}
],
"meta": {
"request_id": "4e774695d4bd72dc9ac089f709b259bb",
"page": {
"limit": 1,
"total": 1,
"has_more": false,
"next_cursor": null
}
},
"links": {
"self": "/api/v1/notifications?page%5Blimit%5D=1&state=all",
"next": null
}
}
Errores verificados para esta operación: 401, 403. Consulte reglas compartidas para conocer el significado del estado y las respuestas a los problemas.
POST /api/v1/notifications/read-all
Propósito: Marca todas las notificaciones propiedad del propietario de la clave como leídas.
Permiso: notifications:write. Solo las notificaciones del propietario de la clave.
Parámetros de consulta: ninguno.
Cuerpo: sin campos de entrada adicionales; sigue el ejemplo.
curl --globoff --silent --show-error \
--request POST \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{}' \
"$BASE_URL/api/v1/notifications/read-all"
Respuesta real: HTTP 200.
{
"data": {
"updated": 0
},
"meta": {
"request_id": "85f72e80bda9476062b33acf913e71e0"
},
"links": {
"self": "/api/v1/notifications/read-all"
}
}
Errores verificados para esta operación: 401, 403. Consulte reglas compartidas para conocer el significado del estado y las respuestas a los problemas.
DELETE /api/v1/notifications/{uuid}
Propósito: Elimina permanentemente una notificación de lectura de propiedad.
Permiso: notifications:write. Solo las notificaciones del propietario de la clave.
Ruta: uuid. Tome los valores de la respuesta anterior. Una ID de página es su clave de documento; nodeId es numérico y UUID no es un slug.
Parámetros de consulta: ninguno.
Cuerpo: sin campos de entrada adicionales; sigue el ejemplo.
Antes de escribir: actualice GET y configure ETAG desde su encabezado ETag.
curl --globoff --silent --show-error \
--request DELETE \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "If-Match: $ETAG" \
"$BASE_URL/api/v1/notifications/0f2851e0-660d-4f78-b8bc-c356d3ff1d9c"
Respuesta real: HTTP 204. El cuerpo está vacío.
Errores verificados para esta operación: 401, 403. Consulte reglas compartidas para conocer el significado del estado y las respuestas a los problemas.
GET /api/v1/notifications/{uuid}
Propósito: Devuelve una notificación propiedad del propietario de la clave.
Permiso: notifications:read. Solo las notificaciones del propietario de la clave.
Ruta: uuid. Tome los valores de la respuesta anterior. Una ID de página es su clave de documento; nodeId es numérico y UUID no es un slug.
Parámetros de consulta: ninguno.
Cuerpo: sin campos de entrada adicionales; sigue el ejemplo.
curl --globoff --silent --show-error \
--request GET \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
"$BASE_URL/api/v1/notifications/0f2851e0-660d-4f78-b8bc-c356d3ff1d9c"
Respuesta real: HTTP 200.
{
"data": {
"id": 1,
"uuid": "0f2851e0-660d-4f78-b8bc-c356d3ff1d9c",
"user_id": 1,
"notification_key": "api.manual.example",
"title": "API workshop reminder",
"message": "Review the API example before the workshop.",
"link_url": "/about",
"source_module": "application",
"source_reference": "api-manual",
"dedup_key": "api-manual-notification",
"data_json": null,
"read_at": null,
"created_at": "2026-11-06 22:48:09",
"updated_at": "2026-11-06 22:48:09",
"is_read": false,
"data": []
},
"meta": {
"request_id": "c7fcdc0d24f01935cd578d7f201b921b"
},
"links": {
"self": "/api/v1/notifications/0f2851e0-660d-4f78-b8bc-c356d3ff1d9c"
}
}
Errores verificados para esta operación: 401, 403, 422. Consulte reglas compartidas para conocer el significado de los estados y las respuestas a los problemas.
PATCH /api/v1/notifications/{uuid}
Propósito: Establece el estado leído/no leído de una notificación de propiedad.
Permiso: notifications:write. Solo las notificaciones del propietario de la clave.
Ruta: uuid. Tome los valores de la respuesta anterior. Una ID de página es su clave de documento; nodeId es numérico y UUID no es un slug.
Parámetros de consulta: ninguno.
Cuerpo/campos admitidos: read. El siguiente ejemplo utiliza valores verificados; Las condiciones y las reglas de reemplazo de listas se describen al comienzo del capítulo.
Antes de escribir: actualice GET y configure ETAG desde su encabezado ETag.
curl --globoff --silent --show-error \
--request PATCH \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "Content-Type: application/json" \
--header "If-Match: $ETAG" \
--data-raw '{
"read": true
}' \
"$BASE_URL/api/v1/notifications/0f2851e0-660d-4f78-b8bc-c356d3ff1d9c"
Respuesta real: HTTP 200.
{
"data": {
"id": 1,
"uuid": "0f2851e0-660d-4f78-b8bc-c356d3ff1d9c",
"user_id": 1,
"notification_key": "api.manual.example",
"title": "API workshop reminder",
"message": "Review the API example before the workshop.",
"link_url": "/about",
"source_module": "application",
"source_reference": "api-manual",
"dedup_key": "api-manual-notification",
"data_json": null,
"read_at": "2026-11-06 22:49:03",
"created_at": "2026-11-06 22:48:09",
"updated_at": "2026-11-06 22:48:09",
"is_read": true,
"data": []
},
"meta": {
"request_id": "6a1d831097fc07de5556f61468f959b6"
},
"links": {
"self": "/api/v1/notifications/0f2851e0-660d-4f78-b8bc-c356d3ff1d9c"
}
}
Errores verificados para esta operación: 401, 403, 422. Consulte reglas compartidas para conocer el significado de los estados y las respuestas a los problemas.
GET /api/v1/me/follow-preferences
Propósito: Devuelve preferencias combinadas de canal personal y cadencia.
Permiso: follows:read. Sólo los seguimientos/preferencias del propietario de la clave; Se vuelve a comprobar el acceso actual a los recursos seguidos.
Parámetros de consulta: ninguno.
Cuerpo: sin campos de entrada adicionales; sigue el ejemplo.
curl --globoff --silent --show-error \
--request GET \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
"$BASE_URL/api/v1/me/follow-preferences"
Respuesta real: HTTP 200.
{
"data": {
"user_id": 1,
"email_mode": "off",
"notify_own_changes": false,
"theme_mode": "auto",
"updated_at": null,
"email_enabled": false
},
"meta": {
"request_id": "98b2df0845176673b3e4ccdf749b2a12"
},
"links": {
"self": "/api/v1/me/follow-preferences"
}
}
Errores verificados para esta operación: 401, 403. Consulte reglas compartidas para conocer el significado del estado y las respuestas a los problemas.
PATCH /api/v1/me/follow-preferences
Propósito: Actualiza parcialmente las preferencias personales sin cambiar las filas de otro usuario.
Permiso: follows:write. Sólo los seguimientos/preferencias del propietario de la clave; Se vuelve a comprobar el acceso actual a los recursos seguidos.
Parámetros de consulta: ninguno.
Cuerpo/campos admitidos: email_enabled, email_mode, notify_own_changes, theme_mode. El siguiente ejemplo utiliza valores verificados; Las condiciones y las reglas de reemplazo de listas se describen al comienzo del capítulo.
curl --globoff --silent --show-error \
--request PATCH \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
"email_enabled": false,
"email_mode": "off",
"notify_own_changes": false
}' \
"$BASE_URL/api/v1/me/follow-preferences"
Respuesta real: HTTP 200.
{
"data": {
"user_id": 1,
"email_mode": "off",
"notify_own_changes": false,
"theme_mode": "auto",
"updated_at": "2026-11-06 22:49:04",
"email_enabled": false
},
"meta": {
"request_id": "0073fb95a0562c45f0f28bdebd4dcd34"
},
"links": {
"self": "/api/v1/me/follow-preferences"
}
}
Errores verificados para esta operación: 401, 403, 422. Consulte reglas compartidas para conocer el significado de los estados y las respuestas a los problemas.
GET /api/v1/me/follows
Propósito: Devuelve ACL seguimientos personales filtrados.
Permiso: follows:read. Sólo los seguimientos/preferencias del propietario de la clave; Se vuelve a comprobar el acceso actual a los recursos seguidos.
Parámetros de consulta: search, type.
Cuerpo: sin campos de entrada adicionales; sigue el ejemplo.
curl --globoff --silent --show-error \
--request GET \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
"$BASE_URL/api/v1/me/follows?type=page&search=API"
Respuesta real: HTTP 200.
{
"data": [
{
"id": 1,
"uuid": "209f707b-18be-4ead-b9fc-4b796eb7c83c",
"user_id": 1,
"target_type": "page",
"target_id": "36",
"workspace_id": 4,
"page_id": 36,
"document_id": "api-plan-radionice",
"label_snapshot": "Plan API radionice",
"email_mode_override": null,
"created_at": "2026-11-06 22:50:09",
"updated_at": "2026-11-06 22:50:09",
"accessible": true,
"label": "Plan API radionice",
"url": "/workspace/api-ogledno-podrucje/api-plan-radionice",
"following": true,
"automatic_excluded": false
}
],
"meta": {
"request_id": "50ba4b674bc6f0ab007022025f0f4ecd"
},
"links": {
"self": "/api/v1/me/follows?type=page&search=API"
}
}
Errores verificados para esta operación: 401, 403. Consulte reglas compartidas para conocer el significado del estado y las respuestas a los problemas.
POST /api/v1/me/follows
Propósito: Agrega un seguimiento de propiedad después de la verificación del dominio ACL.
Permiso: follows:write. Sólo los seguimientos/preferencias del propietario de la clave; Se vuelve a comprobar el acceso actual a los recursos seguidos.
Parámetros de consulta: ninguno.
Cuerpo/campos admitidos: document_id, email_mode_override, label, target_id, target_type. El siguiente ejemplo utiliza valores verificados; Las condiciones y las reglas de reemplazo de listas se describen al comienzo del capítulo.
curl --globoff --silent --show-error \
--request POST \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
--header "Content-Type: application/json" \
--data-raw '{
"target_type": "page",
"target_id": "36",
"label": "API workshop plan"
}' \
"$BASE_URL/api/v1/me/follows"
Respuesta real: HTTP 201.
{
"data": {
"id": 1,
"uuid": "209f707b-18be-4ead-b9fc-4b796eb7c83c",
"user_id": 1,
"target_type": "page",
"target_id": "36",
"workspace_id": 4,
"page_id": 36,
"document_id": "api-plan-radionice",
"label_snapshot": "Plan API radionice",
"email_mode_override": null,
"created_at": "2026-11-06 22:50:09",
"updated_at": "2026-11-06 22:50:09",
"accessible": true,
"label": "Plan API radionice",
"url": "/workspace/api-ogledno-podrucje/api-plan-radionice"
},
"meta": {
"request_id": "21c4c68788859bf941d61d7d43fc8e8b"
},
"links": {
"self": "/api/v1/me/follows"
}
}
Errores verificados para esta operación: 401, 403. Consulte reglas compartidas para conocer el significado del estado y las respuestas a los problemas.
DELETE /api/v1/me/follows/{type}/{targetId}
Propósito: Elimina solo un seguimiento propiedad del propietario de la clave.
Permiso: follows:write. Sólo los seguimientos/preferencias del propietario de la clave; Se vuelve a comprobar el acceso actual a los recursos seguidos.
Ruta: type, targetId. Tome los valores de la respuesta anterior. Una ID de página es su clave de documento; nodeId es numérico y UUID no es un slug.
Parámetros de consulta: ninguno.
Cuerpo: sin campos de entrada adicionales; sigue el ejemplo.
curl --globoff --silent --show-error \
--request DELETE \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
"$BASE_URL/api/v1/me/follows/page/36"
Respuesta real: HTTP 204. El cuerpo está vacío.
Errores verificados para esta operación: 401, 403. Consulte reglas compartidas para conocer el significado del estado y las respuestas a los problemas.
GET /api/v1/me/personal-workspace
Propósito: Devuelve el espacio de trabajo personal del propietario de la clave de API sin los datos de otros usuarios.
Permiso: workspace:read. Sólo los seguimientos/preferencias del propietario de la clave; Se vuelve a comprobar el acceso actual a los recursos seguidos.
Parámetros de consulta: ninguno.
Cuerpo: sin campos de entrada adicionales; sigue el ejemplo.
curl --globoff --silent --show-error \
--request GET \
--header "Authorization: Bearer $SIMBIOZA_API_KEY" \
"$BASE_URL/api/v1/me/personal-workspace"
Respuesta real: HTTP 200.
{
"data": {
"exists": false,
"deleted": false,
"automatic_creation_enabled": true,
"self_creation_enabled": false,
"can_create": false,
"workspace": null
},
"meta": {
"request_id": "2d5ab5b5583445fea4b560c4645137cd"
},
"links": {
"self": "/api/v1/me/personal-workspace"
}
}
Errores verificados para esta operación: 401, 403. Consulte reglas compartidas para conocer el significado del estado y las respuestas a los problemas.
Kommentare
0Es liegen noch keine Kommentare vor.
Sie müssen sich anmelden, um einen Kommentar hinzuzufügen.