À qui s'adresse cette documentation
- Utilisateurs métier : vous composez et faites évoluer les documents de votre organisation (textes, mise en page, tableaux, logos), vous les publiez et vous vérifiez leur rendu. Commencez par les premiers pas, puis l'éditeur.
- Intégrateurs : vous reliez les templates aux données, définissez le contrat de données et branchez vos applications sur l'API. Lisez aussi Données et logique, Clés d'API et intégration et Webhooks.
- Administrateurs d'une organisation : vous gérez les membres, les clés d'API, les webhooks et les polices. Les rôles sont décrits dans les concepts.
Aucune connaissance en programmation n'est nécessaire pour composer un document : l'éditeur ne demande jamais d'écrire du code. Les pages sur l'intégration supposent en revanche que vous savez appeler une API HTTP.
Sommaire
| Page | Ce que vous y trouverez |
|---|---|
| Premiers pas | Se connecter, choisir son organisation, créer un template depuis un modèle de départ, modifier un texte, publier et faire un premier rendu. |
| Concepts | Organisation et rôles, dossiers, template, version et cycle de vie, jeu d'exemple, contrat de données, profils de sortie, rendu et manifeste. |
| Éditeur | Les trois panneaux, les gabarits de page, les en-têtes et pieds, les zones positionnées, le flux du corps, le texte riche, les styles, la palette d'insertion, l'enregistrement et les raccourcis clavier. |
| Données et logique | Variables, jeux d'exemple, contrat, tableaux, tableaux depuis une liste, conditions, répétitions et sous-templates. |
| Publication et versions | Vérifier et publier un brouillon, comparer des versions, déprécier, archiver, revenir à une version, rendus de test et journal des rendus. |
| Clés d'API et intégration | Créer et gérer les clés d'API, appeler l'API, SDK, épinglage des versions, lots, idempotence et erreurs. |
| Polices | Polices de la plateforme, dépôt des polices de votre organisation, substitution signalée. |
| Webhooks | Recevoir les événements de Sculdoc, vérifier la signature, tester et relivrer. |
Repères
- L'application est disponible à l'adresse
https://sculdoc.com. L'espace connecté se trouve sous/app. - L'interface existe en français et en anglais ; la langue se change depuis le menu du compte.
- Pendant la phase pilote, toutes les fonctionnalités sont gratuites ; des quotas protègent seulement la plateforme.
- L'import d'un PDF existant pour en faire un template arrivera dans une prochaine version.
Vocabulaire
| Terme | Sens |
|---|---|
| Template | Modèle d'un document : sa mise en page, ses textes, ses tableaux et les données qu'il attend. |
| Version | État figé et numéroté d'un template, produit par une publication. |
| Brouillon | Version en cours de modification d'un template ; c'est elle que l'éditeur modifie. |
| Jeu d'exemple | Jeu de données nommé qui sert à la preview, aux rendus de test et à la documentation. |
| Contrat de données | Description des données qu'une version attend ; chaque appel est vérifié contre lui. |
| Gabarit de page | Mise en page d'un type de page : format, marges, en-tête, pied, fond et zones fixes. |
| Rendu | Production d'un PDF par le moteur, à partir d'une version et de données. |
| Manifeste | Fiche qui décrit ce qui a produit un document : version, empreintes, moteur, polices, données. |