Skip to main content

Convenções da API

Regras gerais que se aplicam a todos os endpoints da API Obra Play.

Base URL​

AmbienteURL
Staging (testes)https://api-staging.obraplay.com
Produçãohttps://api.obraplay.com

Formato de dados​

Todas as requisições e respostas usam JSON, exceto no envio de arquivos que requer multipart/form-data.

Content-Type: application/json
Accept: application/json

Paginação​

Respostas de listagem são paginadas. Itere enquanto next não for null:

{
  "count": 350,
  "next": "https://api.obraplay.com/api/quotations/?page=3",
  "previous": "https://api.obraplay.com/api/quotations/?page=1",
  "results": [ ... ]
}

Parâmetros disponíveis:

ParâmetroDescrição
pageNúmero da página
limitQuantidade de itens por página
offsetÍndice inicial dos resultados
GET /api/quotations/?limit=20&offset=40

Ordenação​

Use o parâmetro ordering em qualquer listagem. O prefixo - inverte a ordem:

GET /api/quotations/?ordering=-created_at
GET /api/quotations/?ordering=-created_at,status

Idioma das respostas​

Por padrão a API retorna mensagens em inglês. Para receber em português:

Accept-Language: pt-br

Envio de arquivos​

Para uploads (notas fiscais, comprovantes, imagens), use multipart/form-data:

POST /api/orders/5521/supplier_uploads/
Authorization: Token seu_token_aqui
Content-Type: multipart/form-data

file=@nota_fiscal.pdf

Formatos aceitos: PDF, JPG, PNG, XLSX, XLS, CSV
Tamanho máximo: 30 MB por arquivo