L'authentification est réalisée par le biais d'un client Grist. Vous devez créer une table dans Grist pou stocker les clefs d'API keys que vous créez. Cette table doit avoir la structure suivante
| KEY | ROLE | EXPIRATION |
|---|---|---|
| my_key | admin | client | user | 2099-01-01 |
Si vous souhaitez déployer l'API sans authentication par Grist, ne déclarez pas de section auth dans le fichier de configuration. L'authentification sera alors désactivée et l'utilisateur est le rôle de niveau 2 (admin).
L'API implémente un système de rôle à 3 niveaux :
| Niveau du rôle | Description |
|---|---|
| 0 (user) | Aucun droits d'édition sur les collections publiques |
| 1 (client) | Aucun droits d'édition sur les collections publiques |
| 2 (admin) | Droits d'édition sur toutes les collections |
Par défaut, le rate limiting est de 100 requêtes par minute pour tous les niveaux. Il est de 10 requêtes par minute pour le niveau 0 (user) pour les endpoints tagués Core.