API
Leia e altere seus dados do Solid com endpoints REST ou GraphQL gerados a partir do seu próprio modelo de dados.
O Solid gera sua API a partir do seu modelo de dados. Objetos personalizados recebem os mesmos endpoints dos objetos padrão, nomeados conforme seus próprios objetos e campos.
Duas APIs
| API | Caminho | Use para |
|---|---|---|
| Core | /rest/ ou /graphql/ | Criar, ler, atualizar e excluir registros |
| Metadata | /rest/metadata/ ou /metadata/ | Gerenciar objetos, campos e configurações do workspace |
REST e GraphQL acessam os mesmos dados. O GraphQL também busca registros relacionados em uma única chamada e permite upserts em lote.
Autenticação
Envie uma chave de API em toda requisição:
Authorization: Bearer YOUR_API_KEYPara criar uma chave:
- Acesse Configurações → APIs e Webhooks.
- Clique em + Criar chave, dê um nome e uma data de expiração.
- Copie a chave na hora. Ela é exibida só uma vez.
Uma chave de API dá acesso aos seus dados. Atribua a ela um papel limitado em Configurações → Membros → Papéis e exclua-a assim que não for mais necessária.
Uma primeira requisição
Liste empresas com REST:
curl https://YOUR_SOLID_URL/rest/companies \
-H "Authorization: Bearer YOUR_API_KEY"Crie um registro em um objeto personalizado chamado Contracts:
curl -X POST https://YOUR_SOLID_URL/rest/contracts \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Renovação Acme 2026"}'Substitua YOUR_SOLID_URL pelo endereço do seu workspace.
A referência do seu workspace
Como a API segue seu modelo de dados, a referência completa é gerada por workspace. Abra Configurações → APIs e Webhooks, crie uma chave e escolha API REST ou API GraphQL para navegar e testar cada endpoint no playground.