Documentation développeur

Documentation API et téléversement embarqué

Utilisez dataPdf depuis vos propres systèmes avec des clés API pour les intégrations serveur et un flux embarqué hébergé pour les expériences navigateur.

Chemin le plus rapide

Presign, téléversement, confirmation

Authentification

X-API-Key pour les appels serveur

Signal de fin

Notification par e-mail par défaut

Clés API

Les clés API appartiennent à un compte dataPdf individuel. Elles sont destinées aux services backend, aux tâches planifiées et aux outils internes.

Générez et révoquez des clés depuis votre compte sans créer d’espace de travail d’organisation séparé.
Envoyez la clé dans l’en-tête X-API-Key lorsque vous appelez des endpoints protégés.
Toute consommation de pages est facturée au compte propriétaire de la clé, avec des informations société facultatives pour la facturation.

Flux de téléversement presign et confirmation

L’API reprend le flux de téléversement de l’application pour garder les intégrations simples tout en envoyant les gros fichiers directement vers le stockage.

Demandez une URL de téléversement présignée à /api/upload/presign.
Téléversez le fichier directement vers l’URL de stockage renvoyée.
Appelez /api/upload/confirm?start=true pour enregistrer le fichier et lancer le traitement.

Widget de téléversement embarqué

Pour les intégrations navigateur, utilisez un flux embarqué hébergé au lieu d’exposer des clés API dans le code client.

Les utilisateurs s’authentifient avec leur compte dataPdf habituel dans le widget.
Le navigateur doit recevoir un jeton embarqué de courte durée, pas une clé API longue durée.
Utilisez le flux embarqué quand vous voulez un effort d’intégration faible sur un site orienté client.

Limites de sécurité

Gardez les clés API côté serveur et utilisez une auth de session ou de jeton embarqué dans les contextes navigateur.

Ne placez pas de clés API dans les bundles JavaScript, les URLs d’iframe ou le markup public.
Faites tourner les clés si elles ne sont plus nécessaires ou si le propriétaire d’une intégration backend change.
Utilisez les informations de facturation au niveau du compte lorsque les factures doivent afficher des informations société.

Séquence d’intégration minimale

La plupart des équipes n’ont besoin que du flux de téléversement et de la fin par e-mail pour commencer à automatiser l’entrée des PDF.

1. Create an API key in your dataPdf account settings
2. POST /api/upload/presign with X-API-Key
3. Upload the file to the returned storage URL
4. POST /api/upload/confirm?start=true
5. Wait for the completion email or fetch the result later

Langue actuelle : fr. Ajoutez plus tard des captures et exemples de code localisés.