Authentification
Toutes les requêtes à l'API RestifyDocs sont authentifiées via une clé API envoyée dans le header de la requête.
Clé API
Envoyez votre clé dans le header x-api-key de chaque requête :
Bash
curl -H "x-api-key: dk_live_votre_cle" \ https://api.restifydocs.com/v1/templatesSécurité
Ne stockez jamais vos clés API dans le code source ou côté client. Utilisez des variables d'environnement. Les clés
live ont accès aux données de production.Vous pouvez créer et gérer vos clés depuis la console développeur.
Environnements
Chaque clé API est liée à un environnement. Les deux environnements partagent la même URL de base mais les données sont isolées :
| Environnement | Préfixe | Usage |
|---|---|---|
| test | dk_test_ | Développement et tests. Aucun document réel n'est généré. |
| live | dk_live_ | Production. Documents conformes avec numérotation officielle et QR codes. |
Scopes & permissions
Chaque clé est créée avec un ensemble de permissions (scopes) qui limitent les actions possibles :
| Paramètre | Type | Description |
|---|---|---|
documents:generateoptionnel | scope | Générer des documents PDF |
documents:readoptionnel | scope | Lire et lister les documents générés |
documents:bulkoptionnel | scope | Génération en masse (batch) |
templates:readoptionnel | scope | Lire et lister les templates |
templates:writeoptionnel | scope | Créer, modifier et supprimer les templates |
Principe du moindre privilège
Créez des clés avec uniquement les scopes nécessaires. Par exemple, un service qui ne fait que générer des documents n'a besoin que de
documents:generate et templates:read.Exemple de requête
Bash
curl -X GET https://api.restifydocs.com/v1/templates \ -H "x-api-key: dk_test_votre_cle"Si la clé est invalide ou manquante, l'API retourne une erreur 401 Unauthorized. Si la clé n'a pas le scope requis, l'erreur sera 403 Forbidden.