API · help
Operaciones de help del contrato OpenAPI que aceptan una clave de API.
Actualizado:
GET /help/search
Buscar en la ayuda de Fiuit (guías, «¿Qué pasa si…?» y políticas de producto)
FIU-397. La misma búsqueda que usa Wagy: guías de uso del sitio, preguntas frecuentes y el registro de políticas de producto, para que cualquier IA conectada entienda cómo funciona Fiuit. No lee datos del negocio. Sesión con cualquier rol o cualquier API key. Con API key solo salen las políticas vigentes (available=true). documented=false: la ayuda no lo cubre; no inventar pasos ni reglas.
- Autenticación: Clave de API o sesión del panel
- Scopes: Ninguno
Parámetros
| Nombre | En | Obligatorio | Tipo | Descripción |
|---|---|---|---|---|
q | query | Sí | string | La pregunta con sus palabras (incluir «cómo» si es cómo hacer algo). |
locale | query | No | string pt, es, en | Idioma de las guías y respuestas; sin él, el del proyecto. |
limit | query | No | integer default 4 |
Respuestas
| Estado | Descripción |
|---|---|
200 | Secciones de guía, preguntas frecuentes y políticas que responden la consulta (HelpSearchResult) |
422 | Error (RFC 9457) (Problem) |
default | Error (RFC 9457) (Problem) |