API
Lisez et modifiez vos données Solid avec des endpoints REST ou GraphQL générés à partir de votre propre modèle de données.
Solid génère son API à partir de votre modèle de données. Les objets personnalisés disposent des mêmes endpoints que les objets standard, nommés d'après vos propres objets et champs.
Deux API
| API | Chemin | Utilisez-la pour |
|---|---|---|
| Core | /rest/ ou /graphql/ | Créer, lire, mettre à jour et supprimer des enregistrements |
| Metadata | /rest/metadata/ ou /metadata/ | Gérer les objets, les champs et les paramètres de l'espace de travail |
REST et GraphQL donnent accès aux mêmes données. GraphQL permet en outre de récupérer les enregistrements liés en un seul appel et prend en charge les upserts par lots.
Authentification
Envoyez une clé d'API avec chaque requête :
Authorization: Bearer YOUR_API_KEYPour créer une clé :
- Allez dans Paramètres → API et webhooks.
- Cliquez sur + Créer une clé, donnez-lui un nom et une date d'expiration.
- Copiez la clé immédiatement. Elle n'est affichée qu'une seule fois.
Une clé d'API donne accès à vos données. Attribuez-lui un rôle limité dans Paramètres → Membres → Rôles, et supprimez-la dès qu'elle n'est plus nécessaire.
Une première requête
Listez les entreprises avec REST :
curl https://YOUR_SOLID_URL/rest/companies \
-H "Authorization: Bearer YOUR_API_KEY"Créez un enregistrement dans un objet personnalisé nommé Contracts :
curl -X POST https://YOUR_SOLID_URL/rest/contracts \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Renouvellement Acme 2026"}'Remplacez YOUR_SOLID_URL par l'adresse de votre espace de travail.
La référence de votre espace de travail
Comme l'API suit votre modèle de données, sa référence complète est générée pour chaque espace de travail. Ouvrez Paramètres → API et webhooks, créez une clé et choisissez API REST ou API GraphQL pour parcourir et tester chaque endpoint dans le playground.