API CRUD Centralizada

post

https://api.keeptor.com/prd/v1/data

Endpoint único para operações de banco de dados. Dois modos — structured (recomendado, parametrizado e seguro) e raw (SELECT avançado). Cobre SELECT, INSERT, UPDATE, DELETE e UPSERT.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

mode

string

enum

required

Defaults to structured

Sempre 'structured' para operações padronizadas. Use 'raw' apenas para SQL complexo.

Allowed:

operation

string

enum

required

Defaults to select

Qual operação executar: select (buscar), insert (criar), update (alterar), upsert (criar ou alterar), delete (remover).

Allowed:

tables

array of strings

required

Defaults to kpt_core_usr

Nome da tabela. Para JOINs, use alias: ['kpt_core_usr u']. O alias 'u' permite referenciar como 'u.email'.

tables*

columns

array of strings

Defaults to user_id,email,is_active

Quais colunas retornar no SELECT. Use '' para todas. Suporta funções SQL: ['user_id', 'email', 'COUNT() OVER() AS total'].

columns

filters

array of objects

Condições WHERE para filtrar registros. Obrigatório para UPDATE e DELETE. Operadores: =, <>, >, <, >=, <=, like, ilike, in, not in, is, is not.

filters

joins

array of objects

Para relacionar tabelas. Tipos: INNER (só matches), LEFT (todos da esquerda), RIGHT (todos da direita), CROSS (produto cartesiano).

joins

data

⚠️ IMPORTANTE: UPDATE usa objeto { }. INSERT e UPSERT usam array [ { } ]. Todos os objetos do array devem ter as mesmas chaves.

order

array of objects

Ordenação dos resultados. Ex: [{ column: 'created_at', direction: 'DESC' }] para mais recentes primeiro.

order

groupBy

array of strings

Agrupar resultados por coluna(s). Use com funções de agregação como COUNT, SUM, AVG. Ex: ['organization_id'].

groupBy

having

array of objects

Filtrar APÓS o GROUP BY. Ex: mostrar só grupos com COUNT > 10. Sintaxe igual ao 'filters'.

having

limit

integer

Defaults to 10

Máximo de registros a retornar. Use com 'offset' para paginação. Ex: limit=20 retorna no máximo 20 registros.

offset

integer

Defaults to 0

Quantos registros pular. Para página 2 com 20 itens/página, use offset=20. Página 3 = offset=40.

onConflict

string

🔑 OBRIGATÓRIO para UPSERT. Define qual(is) coluna(s) verificar conflito. Coluna única: 'email'. Chave composta: 'org_id,user_id,entity_id' (separar por vírgula, sem espaços).

Responses

200Operação realizada com sucesso (SELECT, UPDATE, DELETE)

201Registro criado com sucesso (INSERT, UPSERT)

400Erro de validação ou constraint

403Permissão negada

500Erro na execução da query