REST API

Endpoints HTTP para coleções e linhas. Use com sua API key (Bearer ou x-api-key).

Visão geral

A API tem um grupo de rotas para integrações:

  • /v1/* — Coleções, linhas e tempo real (API key obrigatória, uso contabilizado)

Autenticação

Para /v1/*, envie sua API key:

Header http
Authorization: Bearer YOUR_API_KEY

API pública (/v1)

Usada pelo seu app via SDK ou HTTP direto. Todas as requisições contam no uso do seu plano.

Coleções

Listar coleções http
GET /v1/collections

[{"name": "users"}, {"name": "products"}]
Criar coleção http
POST /v1/collections

{"name": "users"}

Linhas

Listar linhas http
GET /v1/collections/users/rows?limit=100&offset=0&order_by=id&order=desc

[{"id": 1, "email": "a@b.com"}, {"id": 2, "email": "b@c.com"}]
Inserir linha(s) http
POST /v1/collections/users/rows

[{"email": "a@b.com"}, {"email": "b@c.com"}]
Obter uma linha http
GET /v1/collections/users/rows/1

{"id": 1, "email": "a@b.com"}
Atualizar linha http
PATCH /v1/collections/users/rows/1

{"name": "Alice Updated"}
Excluir linha http
DELETE /v1/collections/users/rows/1

Tempo real

WebSocket http
GET /ws?api_key=YOUR_API_KEY&collection=users&events=insert,update,delete

Health

Health check http
GET /health
# 200 {"ok": true, "service": "onlybase"}