API de Registros

A API de Registros é o coração do sistema para manipulação de dados. Ela permite a persistência, consulta, atualização e exclusão de registros dinâmicos dentro das estruturas criadas pela API de Bases. Sua arquitetura é flexível, utilizando parâmetros de rota dinâmicos e payloads de busca avançada.

Nota – Autenticação Todos os endpoints descritos abaixo requer autenticação via JWT.
Para acessá-los, é necessário enviar um token de autorização no cabeçalho da requisição:

Authorization: Bearer <seu_token_jwt>

---

CRUD Básico de Registros

Operações fundamentais para criar, ler, atualizar e deletar um registro inteiro.

1. Criar um novo registro

Persiste um novo registro JSON em uma base específica.

Endpoint:

POST /:nome_base/reg

Parâmetros de Rota:

Parâmetro	Tipo	Descrição
nome_base	string	Nome da base onde o registro será criado.

Corpo da Requisição (application/json): Um objeto JSON representando o registro a ser inserido.

{
  "cliente": "Empresa X",
  "valor_total": 1500.75,
  "itens": [
    {"produto_id": 1, "quantidade": 10},
    {"produto_id": 5, "quantidade": 2}
  ]
}

2. Buscar um registro por ID

Retorna um registro completo com base no seu ID.

Endpoint:

GET /:nome_base/reg/:id

Parâmetros de Rota:

Parâmetro	Tipo	Descrição
nome_base	string	Nome da base do registro.
id	string	ID do registro a ser consultado.

3. Listar todos os registros de uma base

Retorna todos os registros de uma base, incluindo seus arquivos.

Endpoint:

GET /:nome_base/reg

Parâmetros de Rota:

Parâmetro	Tipo	Descrição
nome_base	string	Nome da base a ser consultada.

4. Atualizar um registro completo

Substitui um registro existente por um novo. O corpo da requisição deve conter o objeto JSON completo com as alterações.

Endpoint:

PUT /:nome_base/reg/:id

Parâmetros de Rota:

Parâmetro	Tipo	Descrição
nome_base	string	Nome da base do registro.
id	string	ID do registro a ser atualizado.

5. Deletar um registro

Remove permanentemente um registro com base no seu ID.

Endpoint:

DELETE /:nome_base/reg/:id

Parâmetros de Rota:

Parâmetro	Tipo	Descrição
nome_base	string	Nome da base do registro.
id	string	ID do registro a ser deletado.

---

Operações Específicas (Patch e Delete Parcial)

Endpoints para modificar ou remover partes específicas de um registro sem a necessidade de enviar o objeto inteiro.

6. Atualizar parte de um registro (Patch)

Atualiza um campo ou sub-objeto específico dentro de um registro. O caminho para o dado é especificado na URL.

Endpoint:

PATCH /:nome_base/reg/:id/*

Exemplo de URL: PATCH /base_vendas/reg/uuid-1234/cliente/endereco

• Neste exemplo, * corresponde a cliente/endereco.

Corpo da Requisição (application/json): O novo valor para o caminho especificado.

{
  "rua": "Nova Rua",
  "cidade": "Nova Cidade"
}

7. Deletar parte de um registro

Deleta um campo ou sub-objeto específico dentro de um registro.

Endpoint:

DELETE /:nome_base/reg/:id/*

Exemplo de URL: DELETE /base_vendas/reg/uuid-1234/itens/item-5678

• Neste exemplo, * corresponde a itens/item-5678, removendo um item específico da lista.

---