Portal de documentação do IRIS

O IRIS expõe um contrato de leitura neutro sobre o corpus de marcas do INAPI: uma API REST versionada (sob /v1) e um servidor Model Context Protocol (MCP), ambos apoiados na mesma camada de consultas e nos mesmos schemas Zod, de modo que os dois transportes retornam resultados idênticos. Este portal é a documentação de primeiros passos voltada a pessoas; é neutro e reutilizável por qualquer consumidor.

O schema autoritativo vive na referência OpenAPI ao vivo em /docs (uma página Scalar interativa gerada a partir do código). Estes guias explicam como fazer os primeiros passos e apontam para essa referência — eles não duplicam o schema. Quando um detalhe de campo ou endpoint não estiver descrito aqui, /docs é a fonte da verdade.

Guias de integração (DOCS-01)

Guia	O que cobre
Primeiros passos	URL base + /v1, obtenção de uma chave emitida pelo operador, primeira chamada GET /v1/brands (curl + TS fetch), paginação/filtragem por keyset, o envelope de erro, noções básicas de cota.
Autenticação e escopos	O header X-API-Key, os escopos brands:read / insights:read (vazio = irrestrito), o ciclo de vida da chave (rotacionar/revogar/expirar) e a semântica de 401 / 403 / 429.
Conecte seu agente de IA (MCP)	O endpoint https://mcp.obviouy.com, X-API-Key, transporte Streamable HTTP, as ferramentas search_brands / get_brand_detail e exemplos de configuração de cliente.
Exemplos de código	Clientes REST (curl + TS fetch) e MCP (@modelcontextprotocol/sdk) prontos para copiar e colar.

Contrato e operações (DOCS-02)

Documento	O que cobre
Changelog	Histórico de versões (estilo Keep a Changelog).
Status	Status do serviço e onde ficam as superfícies ao vivo de atualidade/saúde.
Versionamento e descontinuação	O contrato do prefixo /v1 e como mudanças incompatíveis ganham uma nova versão.
SLA	Postura de disponibilidade, cadência de sync/atualidade, expectativas de suporte.

Os documentos DOCS-02 são produzidos pelo plano irmão desta fase; seus links estão listados aqui para que este índice seja o único ponto de entrada para todo o portal.

Referência autoritativa da API

O schema REST completo, sempre atualizado e por campo, é a referência OpenAPI (Scalar) interativa servida em https://iris.obviouy.com/docs. Comece pelos guias acima para fazer os primeiros passos e, em seguida, use essa referência como o schema canônico para todo endpoint, parâmetro e formato de resposta.