Voltar a Programadores

API de Dados

Lê e escreve qualquer entidade do teu workspace — dinâmica e core — através de uma interface REST simples.

Visão geral

A API de Dados dá-te CRUD completo sobre todas as entidades do teu workspace: os módulos que crias no Builder e os core como RH. Os mesmos URLs, o mesmo JSON, seja qual for o teu modelo de dados.

Cada chamada passa pelo mesmo motor que a app usa — as tuas regras de registo, permissões de campo e pipeline de validação aplicam-se todas — por isso a API nunca contorna a tua lógica de negócio.

Data analytics dashboard on a laptop

O que podes fazer

Listar, filtrar e pesquisar

Pagina registos com page/limit, pesquisa de texto, ordenação e filtros de igualdade em qualquer campo.

Criar e atualizar

Escreve registos com um envelope data simples; atualizações parciais e concorrência otimista suportadas.

Consciente do schema

Obtém o schema de uma entidade para descobrir campos e tipos antes de ler ou escrever.

Referência

Autentica com uma chave Bearer e chama os endpoints limpos.

# List employees (paginated, searchable, filterable)
curl "https://api.megorix.com/data/hr/employees?page=1&limit=20&search=ana&status=active" \
  -H "Authorization: Bearer $MEGORIX_API_KEY"

# Create a record
curl -X POST https://api.megorix.com/data/hr/employees \
  -H "Authorization: Bearer $MEGORIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "data": { "firstName": "Ana", "lastName": "Silva" } }'

# Update a record (partial)
curl -X PATCH https://api.megorix.com/data/hr/employees/<id> \
  -H "Authorization: Bearer $MEGORIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "data": { "lastName": "Costa" } }'
Endpoints
GET
/data/:moduleSlug/:entitySlugList records (page, limit, search, filters)
GET
/data/:moduleSlug/:entitySlug/schemaEntity schema (fields + types)
GET
/data/:moduleSlug/:entitySlug/:idGet one record
POST
/data/:moduleSlug/:entitySlugCreate a record
PATCH
/data/:moduleSlug/:entitySlug/:idUpdate a record
DELETE
/data/:moduleSlug/:entitySlug/:idDelete a record

Experimenta agora

Abre a referência interativa da API e faz a tua primeira chamada em minutos.

    API de Dados — Programadores Megorix | Megorix