API REST
Usa la API HTTP de Neotoma cuando una aplicación necesite un contrato estructurado de solicitud y respuesta para el registro.
Comprueba primero el destino
Una API local de desarrollo y una API local de producción pueden usar puertos y directorios de datos diferentes. Una API alojada tiene su propia URL y política de acceso. Comprueba la URL base y la autenticación previstas antes de escribir. GET /health puede mostrar que un proceso responde, pero no demuestra que su perfil de datos sea el que querías usar. Leer una entidad conocida es una comprobación más sólida; en un perfil nuevo y vacío hará falta leer de nuevo la primera escritura autorizada por el usuario.
El servidor expone GET /openapi.yaml con el contrato de rutas. La referencia REST completa explica URL base, autenticación, envolturas de error, paginación, descubrimiento OAuth y endpoints auxiliares. La mayoría de las rutas de registro necesitan una credencial; una respuesta pública de salud o descubrimiento no demuestra que funcione una llamada protegida.
Operaciones habituales del registro
| Finalidad | Operación HTTP | Qué verificar |
|---|---|---|
| Guardar entidades estructuradas | POST /store |
ID de entidad devueltos y campos previstos de la instantánea |
| Buscar entidades por filtros | POST /entities/query |
Ámbito, tipo, paginación y un caso conocido que dé resultado |
| Examinar una entidad actual | POST /get_entity_snapshot |
Valores de campos y procedencia |
| Corregir un campo | POST /correct |
Instantánea nueva e historial de observaciones |
Estos nombres describen vías de acceso, no cuerpos completos de solicitud. Usa OpenAPI para los parámetros obligatorios y las formas de respuesta, sobre todo al pasar de una versión a otra. La referencia CLI documenta también neotoma request --operation, que llama a las operaciones por sus ID de OpenAPI sin construir una solicitud HTTP improvisada.
Comprueba el efecto
Las llamadas de almacenamiento, corrección y búsqueda pueden devolver una respuesta válida sin resolver la pregunta que pretendías contestar. Comprueba el tipo de entidad y los campos declarados, compara el ID devuelto con la entidad esperada y después recupera la instantánea actual. Ante una búsqueda sin resultados, repite una consulta conocida que dé resultado contra la misma instancia y ámbito de usuario antes de concluir que faltan datos. Buscar y leer un registro y Guardar y corregir un registro describen esos flujos sin depender de una biblioteca cliente.
Temas relacionados
MCPNeotoma expone herramientas mediante Model Context Protocol para que un entorno de IA configurado pueda leer y escribir en el mismo registro.
CLILa CLI de Neotoma es una vía de acceso desde la terminal al mismo registro que exponen MCP y HTTP.
Buscar y leer un registroEmpieza por la identidad y el tipo de lo que necesitas; después examina el valor actual y su evidencia.