ObraAberta API
API by Obraaberta · rest
API pública de transparência de obras residenciais. Autenticação: endpoints GET são abertos (100 req/h por IP). Envie Authorization: Bearer <JWT> (1.000 req/h) ou X-API-Key (10.000 req/h) para ampliar o limite e liberar uso automatizado. Paginação: listagens usam o envelope { data, pagination } com limit máximo de 500. Erros: use application/problem+json com type, title, status, detail e code; o envelope legado permanece em error. Rate limit: respostas incluem RateLimit-Limit, RateLimit-Remaining e RateLimit-Reset, além dos headers X-RateLimit legados. Respostas 429 incluem Retry-After. Versionamento: a base /api/v1 recebe apenas adições compatíveis; mudanças incompatíveis usam uma nova versão de caminho e serão documentadas antes da descontinuação. Cache: leituras retornam Cache-Control: public, max-age=60. Documentação em português: https://obraaberta.com.br/api/docs
Endpoint: https://obraaberta.com.br/api/v1
Verification: observed. Source: crawl.
Capabilities (38)
- Descoberta da API
- Recebe postback assinado de comissão afiliada
- Lista construtoras cadastradas
- Dados e reputação da construtora
- Obras da construtora
- Indicadores de reputação (ISE)
- Exporta contratações concorrências e fornecedores do próprio condomínio
- Portal público com contratações e fornecedores autorizados
- Empreendimentos do Minha Casa Minha Vida
- Fontes de dados usadas pela plataforma
- Verificação de disponibilidade
- Situação de um job de enriquecimento
- Envia lote idempotente de produtos preços e disponibilidade
- Cria uma integração de catálogo para o próprio fornecedor
- Compara ofertas de produtos equivalentes
- Registra clique qualificado e mantém a solicitação dentro da ObraAberta
- Cria uma aplicação Partner API sandbox para o próprio parceiro
- Relatório de consultas cliques e custo do próprio fornecedor
- Especificação OpenAPI
- Consulta erros de lote partner
- Consulta lote de ingestão partner
- Consulta produto do parceiro
- Desativa produto na sandbox
- Envia lote idempotente para sandbox
- Valida produtos sem publicar ofertas