URL de base et versioning

URL de base

Toutes les requêtes API sont effectuées à :

https://api.docpayload.com/v1

Versioning de l'API

La version de l'API est incluse dans le chemin de l'URL. La version actuelle est v1.

Lorsque des modifications incompatibles sont introduites, une nouvelle version est publiée (par exemple, v2). Les versions précédentes restent disponibles pendant une période d'obsolescence avec avis préalable.

Format de requête

Tous les corps de requête doivent être en JSON avec l'en-tête Content-Type: application/json.

curl -X POST https://api.docpayload.com/v1/{YOUR_TENANT_ID}/documents/generate-from-payload/pdf \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "document": { ... } }'
# { "fileName": "...", "downloadUrl": "...", "status": "Completed" }

Format de réponse

• Les points de terminaison de génération de document retournent JSON avec fileName, downloadUrl et status
• Les points de terminaison CRUD retournent application/json
• Toutes les réponses d'erreur sont JSON avec les champs status, message et details optionnel

Limites de débit

Plan	Requêtes/minute	Documents/mois
Free	10	100
Pro	60	5 000
Enterprise	Personnalisé	Personnalisé

Les en-têtes de limite de débit sont inclus dans chaque réponse :

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 57
X-RateLimit-Reset: 1711843200