API
Lesen und ändern Sie Ihre Solid-Daten über REST- oder GraphQL-Endpunkte, die aus Ihrem eigenen Datenmodell generiert werden.
Solid generiert seine API aus Ihrem Datenmodell. Benutzerdefinierte Objekte erhalten dieselben Endpunkte wie die Standardobjekte, benannt nach Ihren eigenen Objekten und Feldern.
Zwei APIs
| API | Pfad | Verwendung |
|---|---|---|
| Core | /rest/ oder /graphql/ | Datensätze erstellen, lesen, aktualisieren und löschen |
| Metadata | /rest/metadata/ oder /metadata/ | Objekte, Felder und Workspace-Einstellungen verwalten |
REST und GraphQL greifen auf dieselben Daten zu. GraphQL ruft zusätzlich verknüpfte Datensätze in einem einzigen Aufruf ab und unterstützt Batch-Upserts.
Authentifizierung
Senden Sie bei jeder Anfrage einen API-Schlüssel mit:
Authorization: Bearer YOUR_API_KEYSo erstellen Sie einen Schlüssel:
- Öffnen Sie Einstellungen → APIs & Webhooks.
- Klicken Sie auf + Schlüssel erstellen und vergeben Sie einen Namen und ein Ablaufdatum.
- Kopieren Sie den Schlüssel sofort. Er wird nur einmal angezeigt.
Ein API-Schlüssel gewährt Zugriff auf Ihre Daten. Weisen Sie ihm unter Einstellungen → Mitglieder → Rollen eine eingeschränkte Rolle zu und löschen Sie ihn, sobald er nicht mehr benötigt wird.
Eine erste Anfrage
Unternehmen per REST auflisten:
curl https://YOUR_SOLID_URL/rest/companies \
-H "Authorization: Bearer YOUR_API_KEY"Einen Datensatz in einem benutzerdefinierten Objekt namens Contracts erstellen:
curl -X POST https://YOUR_SOLID_URL/rest/contracts \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Acme Verlängerung 2026"}'Ersetzen Sie YOUR_SOLID_URL durch die Adresse Ihres Workspace.
Die Referenz Ihres Workspace
Da die API Ihrem Datenmodell folgt, wird ihre vollständige Referenz pro Workspace generiert. Öffnen Sie Einstellungen → APIs & Webhooks, erstellen Sie einen Schlüssel und wählen Sie REST API oder GraphQL API, um alle Endpunkte im Playground zu durchsuchen und auszuprobieren.