Centros de ayuda
Crea un centro de respuestas independiente de los agentes. El servicio se habilita en el contrato del cliente desde Central, con la opción Centros de ayuda.
En el panel, abre Centros de ayuda → Nuevo centro. Escribe un nombre, una dirección y elige el acceso. La dirección se conserva después de crear el centro.
- Público: cualquier visitante puede consultar los artículos publicados en el portal y cualquier sitio puede leerlos por API sin credenciales.
- Privado: solo los miembros autorizados de la empresa y las claves de servidor con permiso de lectura pueden acceder. El portal público devuelve «no disponible».
- Indexable: un centro público puede permitir que los buscadores indexen sus artículos. Por defecto está desactivado y el portal responde con
noindexy sin caché.
Los propietarios y administradores editan artículos. Los demás miembros pueden leer los artículos publicados. Cada artículo tiene título, categoría, contenido, etiquetas, una dirección propia (slug) generada del título y editable, una posición en el listado y la opción de destacarlo. Guardar crea un borrador; usa Leer → Publicar artículo para actualizar el portal. Una modificación posterior del borrador no cambia la versión pública hasta volver a publicarla. Retirar publicación oculta el artículo. Las eliminaciones se confirman y quedan auditadas.
Los lectores del portal pueden indicar si un artículo les sirvió. Los conteos aparecen en el panel y en la API. La búsqueda consulta texto publicado en la base de datos. Los borradores y centros privados no se incluyen en las respuestas públicas. El contenido se presenta como texto, sin ejecutar HTML.
El icono Configurar Centros de ayuda abre Configuración → Centros de ayuda: indexación por centro, direcciones públicas y de API, claves, ejemplos, webhooks y actividad por API.
API
Usa una clave de servidor de producción con help_centers:read o help_centers:write. Consultar borradores requiere permiso de escritura; /reader permite leer lo publicado con permiso de lectura. Las claves de sandbox no acceden a estos recursos. No publiques la clave en un navegador. Cada acción hecha con una clave queda en auditoría con el identificador de la clave.
| Método | Ruta | Función |
|---|---|---|
| GET / POST | /v1/help-centers |
Listar o crear centros |
| PATCH / DELETE | /v1/help-centers/:id |
Cambiar acceso, datos, indexación o eliminar el centro |
| GET / POST | /v1/help-centers/:id/articles |
Listar borradores (filtros status, category, label, promoted, sort) o crear un artículo |
| GET / PATCH / DELETE | /v1/help-centers/:id/articles/:article |
Leer el borrador, guardar o eliminar un artículo |
| POST | /v1/help-centers/:id/articles/:article/publish |
Publicar la revisión indicada |
| POST | /v1/help-centers/:id/articles/:article/unpublish |
Retirar la revisión indicada |
| GET | /v1/help-centers/:id/categories |
Categorías publicadas con conteo; ?status=draft cuenta borradores |
| GET | /v1/help-centers/:id/reader |
Leer únicamente el contenido publicado del centro autorizado |
| GET | /v1/help-centers/:id/reader/:slug |
Un artículo publicado por dirección |
Crear un centro: { "name": "Ayuda para clientes", "slug": "clientes", "description": "Respuestas frecuentes", "visibility": "public", "indexable": true }.
Crear un artículo: { "title": "Cómo empezar", "body": "Abre tu panel y configura el servicio.", "category": "Primeros pasos", "labels": ["inicio"], "slug": "como-empezar", "position": 1, "promoted": true }. Solo title y body son obligatorios; la dirección se genera del título si no la envías y recibe un sufijo si ya existe en el centro.
Al editar un artículo agrega revision con el número obtenido al leerlo. Publicar o retirar requiere { "revision": 1 }, sustituyendo el número por la revisión actual. Una revisión desactualizada devuelve 409 para evitar sobrescribir cambios de otra persona.
Los listados aceptan q, page y pageSize (10, 20, 30 o 50). status admite draft, published o changed (publicados con cambios sin publicar). sort admite position (destacados primero), updated_at o title.
Límite de tasa: 120 solicitudes por minuto por clave, con cabeceras X-RateLimit-Limit y X-RateLimit-Remaining.
API pública de lectura
Sin credenciales, solo para centros públicos. Puedes consumirla desde el navegador de tu propio sitio: la API acepta cualquier origen.
| Método | Ruta | Función |
|---|---|---|
| GET | /public/help/:empresa/:centro |
Artículos publicados. fields=summary devuelve título, categoría, etiquetas y resumen sin el cuerpo; q, category, label, promoted, sort, page, pageSize |
| GET | /public/help/:empresa/:centro/articles/:slug |
Un artículo completo con artículos relacionados de la misma categoría |
| GET | /public/help/:empresa/:centro/categories |
Categorías con conteo de artículos publicados |
| POST | /public/help/:empresa/:centro/articles/:slug/feedback |
{ "helpful": true, "request_id": "UUID" }; una opinión por referencia, 30 por minuto e IP |
Cuando el centro es indexable la lectura pública responde con Cache-Control: public, max-age=60; en caso contrario con no-store y X-Robots-Tag: noindex. Con q, cada resultado incluye snippet con el fragmento donde aparece la búsqueda.
Webhooks
Suscribe un endpoint de producción a help.article_published o help.article_unpublished. El cuerpo incluye data.center_id, data.article_id, data.slug, data.revision, data.title y data.category. Consulta webhooks.
El cambio a privado se aplica en las siguientes consultas; el contenido que un visitante ya leyó no puede retirarse de su dispositivo. Esta entrega no incluye dominios personalizados, varios idiomas, historial completo de versiones ni generación de artículos con IA.