Bando
GitHubComunidade

Documentação Bando

Autenticação REST

Autentica clientes e utiliza tokens Bearer para acessar recursos protegidos.

Por que existe autenticação?

A API do Bando pode conter conteúdo privado e operações que alteram dados. Por isso, determinados endpoints exigem uma API key válida para autorizar o acesso.

Como funciona

1. API KeyO cliente obtém uma API key do projeto Bando.
2. RequestO cliente envia a API key no header da request.
3. APIO Bando valida a API key apresentada.
4. ResponseA API processa a request se a autenticação for válida.

Usar uma API key

Requests para a Document API devem incluir a API key através do header X-Bando-API-Key.

GET/api/:collection

Envia a API key no header da request.

BASH
curl http://localhost:3333/api/posts \
-H "X-Bando-API-Key: YOUR_API_KEY"

Em JavaScript, a API key pode ser enviada da seguinte forma:

JAVASCRIPT
const response = await fetch(
"http://localhost:3333/api/posts",
{
headers: {
"X-Bando-API-Key": "YOUR_API_KEY",
},
}
);
​
const { data } = await response.json();

API key no header

O header X-Bando-API-Key identifica e autentica o projeto que está fazendo a request.

HTTP
X-Bando-API-Key: YOUR_API_KEY

Requests autenticadas

A autenticação é necessária para os endpoints da Document API protegidos. A API key deve ser enviada em cada request que exigir autenticação.

BASH
curl http://localhost:3333/api/posts \
-H "X-Bando-API-Key: $BANDO_API_KEY"

Erros de autenticação

Requests sem uma API key válida não são autorizadas pela API. Verifica se o header está presente e se a API key pertence ao projeto correto.

  • X-Bando-API-Key ausente — a request não está autenticada.
  • API key inválida — a autenticação falha.
  • API key válida — a request pode ser processada de acordo com as permissões disponíveis.