Integração com a API Obra Play
Bem-vindo à documentação de integração do Obra Play.
A API do Obra Play é uma interface REST que permite a sistemas externos participarem ativamente do marketplace de construção civil. Por meio dela, sua plataforma pode criar cotações de materiais/serviços, envia-las para fornecedores, receber respostas e por fim gerenciar ordens de compra — tudo de forma automatizada e segura.
Para quem é esta documentação?
Esta seção é direcionada a equipes de desenvolvimento de empresas parceiras que desejam integrar seus sistemas à plataforma Obra Play. Exemplos de casos de uso:
- Fornecedores e distribuidores que querem receber cotações e receber respostas
- ERPs e sistemas de gestão que precisam sincronizar ordens de compra
- Plataformas de construção que desejam conectar seus construtores ao marketplace Obra Play
Como a plataforma funciona
O fluxo central da Obra Play é:
Construtor cria Cotação (Quotation)
↓
Fornecedores recebem e respondem (QuotationAnswer)
↓
Construtor escolha a melhor proposta
↓
Proposta vira Pedido (Order)
↓
Fornecedor processa e entrega
Ao integrar com a Obra Play, sua empresa pode atuar em uma ou mais etapas desse fluxo.
Referência completa da API
A documentação interativa com todas as rotas, parâmetros, payloads e exemplos de resposta está disponível no Swagger:
| Ambiente | URL |
|---|---|
| Staging (testes e desenvolvimento) | https://api-staging.obraplay.com/apidocs |
| Produção | Acesso liberado após aprovação do suporte |
Recomendação
Valide sua integração no ambiente de Staging antes de apontar para Produção.
Próximos passos
- Autenticação — como obter e usar seu token de acesso
- Guia de Integração — fluxo completo com exemplos reais de request e response
- Convenções da API — paginação, ordenação, filtros e formatos
- Webhooks — como receber notificações em tempo real
- Solução de Problemas — erros comuns e como resolvê-los
Suporte
Em caso de dúvidas sobre a integração, entre em contato com o time de tecnologia da Obra Play.