Premiers pas

Ce que fait Doclift

Doclift génère des documents PDF à partir de modèles que vous concevez une fois et réutilisez depuis votre serveur. Vous envoyez un identifiant de modèle et un ensemble de variables, Doclift génère le document et vous le renvoie via un webhook une fois qu'il est prêt. La mise en page vit en dehors de votre code, donc la modifier ne nécessite jamais de déploiement.

Créer votre compte

Inscrivez-vous. Un environnement sandbox est disponible immédiatement. Voir Environnements pour ce qui distingue sandbox et production.

Créer une clé d'API

Chaque requête s'authentifie avec une clé d'API, appelée application externe dans le dashboard. Créez-en une et choisissez son environnement (sandbox ou production).

Copiez la clé dès qu'elle est générée. Ensuite, Doclift ne vous la montre plus que masquée (revealable_secret_key, tous les caractères remplacés par • sauf les 8 derniers). Il n'existe aucun moyen de récupérer à nouveau la valeur brute depuis le dashboard ou l'API.

Envoyer votre première requête

GET /api/v1/user ne nécessite aucune autre configuration et confirme que votre clé fonctionne :

curl https://app.doclift.io/api/v1/user \
  -H "X-Api-Key: <your-api-key>"

{
  "id": 100001,
  "firstname": "John",
  "lastname": "Doe",
  "email": "[email protected]",
  "current_external_application": {
    "name": "My App",
    "environment": "sandbox",
    "active": true
  }
}

La référence complète des champs, y compris les limites de votre organisation, se trouve sur Bases de l'API.

À quoi ressemble un échec

Chaque requête répond 403 Forbidden si la clé est absente, inconnue, ou appartient à une application externe désactivée. C'est toujours l'un de ces deux corps, jamais un message générique :

{ "error": "Please add an 'X-Api-Key' HTTP header." }

{ "error": "Invalid or disabled API Key" }

Une clé désactivée et une clé inconnue répondent à l'identique. Vous ne pouvez pas les distinguer à partir de la réponse. La référence complète des codes de statut et de l'enveloppe d'erreur se trouve sur Bases de l'API.

Choisir la bonne famille de modèles avant de commencer

Doclift a trois familles de modèles (custom, fillable_form, et workflow) et elles n'exposent pas la même surface d'API. Envoyer un identifiant fillable_form ou workflow à un endpoint d'édition de modèle échoue avec un 404, identique à un identifiant qui n'existe pas du tout. Lisez Types de modèles avant de créer votre premier modèle : cinq minutes de lecture qui vous épargnent un après-midi perdu.

Suite