Portal de documentación de IRIS
IRIS expone un contrato de lectura neutral sobre el corpus de marcas de INAPI: una API REST
versionada (bajo /v1) y un servidor Model Context Protocol (MCP), ambos respaldados por la misma capa de consultas
y los mismos esquemas de Zod, de modo que los dos transportes devuelven resultados idénticos. Este portal es la
documentación de puesta en marcha orientada a personas; es neutral y reutilizable entre consumidores.
El esquema autoritativo vive en la referencia OpenAPI en vivo en
/docs(una página Scalar interactiva generada a partir del código). Estas guías explican cómo hacer la puesta en marcha y enlazan a esa referencia — no duplican el esquema. Cuando el detalle de un campo o endpoint no está especificado aquí,/docses la fuente de verdad.
Guías de integración (DOCS-01)
| Guía | Qué cubre |
|---|---|
| Primeros pasos | URL base + /v1, obtener una clave emitida por el operador, la primera llamada GET /v1/brands (curl + TS fetch), paginación/filtrado por keyset, el sobre de error y los conceptos básicos de cuota. |
| Autenticación y scopes | El encabezado X-API-Key, los scopes brands:read / insights:read (vacío = sin restricción), el ciclo de vida de la clave (rotar/revocar/expiración) y la semántica de 401 / 403 / 429. |
| Conecta tu agente de IA (MCP) | El endpoint https://mcp.obviouy.com, X-API-Key, el transporte Streamable HTTP, las herramientas search_brands / get_brand_detail y configuraciones de cliente de ejemplo. |
| Ejemplos de código | Clientes REST (curl + TS fetch) y MCP (@modelcontextprotocol/sdk) listos para copiar y pegar. |
Contrato y operaciones (DOCS-02)
| Documento | Qué cubre |
|---|---|
| Changelog | Historial de versiones (estilo Keep a Changelog). |
| Estado | Estado del servicio y dónde se muestran la frescura/salud en vivo. |
| Versionado y obsolescencia | El contrato del prefijo /v1 y cómo los cambios incompatibles obtienen una nueva versión. |
| SLA | Postura de disponibilidad, cadencia de sync/frescura, expectativas de soporte. |
Los documentos DOCS-02 los produce el plan hermano de esta fase; sus enlaces se listan aquí para que este índice sea el único punto de entrada a todo el portal.
Referencia autoritativa de la API
El esquema REST completo y siempre actualizado por campo es la referencia OpenAPI (Scalar) interactiva
servida en https://iris.obviouy.com/docs. Comienza con las
guías anteriores para la puesta en marcha y luego usa esa referencia como el esquema canónico para cada endpoint,
parámetro y forma de respuesta.