Sculdoc

Référence de l'API

Pour les développeurs : authentification par clé, premier rendu, SDK et CLI, erreurs structurées, contrat OpenAPI.
Contrat OpenAPI
Toutes les opérations, leurs paramètres, leurs réponses et les erreurs structurées.
Ouvrir openapi.json

Authentification

Les applications appellent l'API avec une clé d'API de leur organisation, dans l'en-tête x-api-key. Les clés se créent depuis l'espace de l'organisation.

Premier rendu

Un rendu synchrone renvoie le PDF ; ajoutez Accept: application/json pour sa description (identifiant, pages, manifeste).

curl
curl https://sculdoc.com/v1/renders \
	-H "x-api-key: $SCULDOC_API_KEY" \
	-H 'content-type: application/json' \
	-d '{"template":"certificat","version":3,"sample":"standard"}' \
	-o certificat.pdf

SDK et CLI

Clients TypeScript, Java, C# et Python générés depuis le contrat ; la CLI synchronise vos templates depuis un dépôt et les publie.

terminal
pnpm add @supscale/sculdoc-client          # TypeScript
sculdoc sdk generate --lang ts,java,csharp,python   # typed SDK of a template version

Erreurs

Chaque erreur porte un code stable, un message et la liste des champs en cause (chemins JSON) : 400 requête mal formée, 404 ressource inconnue dans l'organisation, 409 conflit, 422 données ou template invalides, 429 limite atteinte avec le délai à attendre.

422
{
	"error": {
		"code": "data.invalid",
		"message": "data does not match the contract of certificat v3",
		"issues": [{ "path": "$.client.nom", "message": "required" }]
	},
	"requestId": "01JD…"
}