Documentation Index
Fetch the complete documentation index at: https://docs.refy.to/llms.txt
Use this file to discover all available pages before exploring further.
Documentacao do Refy
Esta documentação existe para duas audiências:- quem integra com a API do Refy
- quem quer entender como o produto organiza analise, backlog, monitoramento e pontuacao
O que usar como fonte de verdade
Para integração técnica:- o contrato principal é
openapi/refy-rest.yaml
- use as páginas desta documentação
Como a documentação está organizada
Primeiros passos
Mostra o caminho mais curto para:- autenticar
- criar o primeiro contexto
- iniciar uma análise
- consumir o payload principal do produto
Fluxos do produto
Estas paginas explicam o modelo conceitual por tras da API:- areas de trabalho e projetos
- analises
- backlog
- monitoramento
- conectores
- cobranca
Referencia da API REST
A referencia tecnica de endpoints e gerada automaticamente a partir do OpenAPI. Isso significa que:- os endpoints não precisam ser escritos manualmente
- exemplos de request/response ficam proximos do contrato
- a documentação técnica tende a ficar mais confiável
- a superficie de referencia pode evoluir sem quebrar a documentacao editorial
Pontuacao
A parte de scoring foi separada em duas camadas:- visão acessível de produto
- metodologia técnica atual
O que você encontra aqui
Comece aqui
- autenticação
- onboarding técnico
- como criar area de trabalho, projeto e primeira analise
Fluxos do produto
- análises
- backlog
- monitoramento
- conectores
- cobranca
Pontuacao
- explicação de produto
- metodologia atual do motor
Referencia da API REST
A referencia de endpoints e gerada a partir do arquivo OpenAPI, em vez de ser escrita manualmente. Isso evita deriva entre:- documentação
- implementação
- tooling
Importante
O portal público de documentação deve ser servido pelo Mintlify, não pelo app web principal do produto. O app do produto continua com foco em:- landing
- signup/login
- onboarding
- área autenticada