Aller au contenu principal

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.

YOUR_ACCESS_TOKEN est le jeton d'accès obtenu en échangeant le Client ID et le secret de votre clé API ; voir Authentification.

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

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​

Ce qui est comptéLimite
Documents générés (generate-from-payload, generate-from-template)600 par minute et par tenant
Toute autre requête (téléchargements, modèles, ressources)6 000 par minute et par tenant, pour chaque point de terminaison

La limite de documents est propre à votre tenant et peut être relevée sur demande. Un téléchargement ne compte jamais comme un document.

Une requête au-delà d'une limite reçoit 429 Too Many Requests, avec le nombre de secondes à attendre dans l'en-tête Retry-After :

HTTP/1.1 429 Too Many Requests
Retry-After: 37