Documentação Bando

Documents REST API

Consulta e altera collections e documentos diretamente através de HTTP.

A API de documentos

A API REST permite que qualquer aplicação capaz de fazer requests HTTP trabalhe com os documentos do Bando.

Se estás a construir uma aplicação React, Vue, mobile ou qualquer outro cliente HTTP, não precisas utilizar o cliente TypeScript. Podes consumir estas rotas diretamente.

Métodos HTTP

GET
Ler dados.

POST
Criar dados.

PATCH
Atualizar dados.

DELETE
Remover dados.

GET/api/collections

Lista as collections disponíveis.

Também é possível consultar uma collection específica através de GET /api/collections/:name.

GET/api/:collection

Lista documentos de uma collection.

A resposta possui os documentos em data e o número total em total.

{

"data": [],

"total": 0

}

Parâmetro	Tipo	Obrigatório	Por omissão	Descrição
`limit`	integer	não	—	Número máximo de documentos devolvidos. Deve ser um inteiro não negativo.
`offset`	integer	não	0	Número de documentos ignorados antes de começar a devolver resultados.
`sort`	string	não	-createdAt	Campo usado para ordenar os resultados. Aceita id, createdAt ou updatedAt. O prefixo - indica ordem descendente.
`field`	string	não	—	Filtro por igualdade. Por exemplo, published=true procura documentos cujo campo published seja verdadeiro.

GET/api/:collection/:id

Procura um documento específico pelo ID.

Em caso de sucesso devolve:

{

"data": {

"id": "...",

"collection": "...",

"data": {}

}

POST/api/:collection

Cria um novo documento. Os dados são enviados no body da request.

Em caso de sucesso a API devolve 201.

PATCH/api/:collection/:id

Atualiza parcialmente um documento existente.

DELETE/api/:collection/:id

Remove um documento.

Em caso de sucesso devolve 204.

Erros de validação devolvem 400 com informações emerror e issues.

Ver autenticação REST →