OpenAPI comme source
Les méthodes, chemins et descriptions d’opérations proviennent du contrat OpenAPI téléchargeable.
Capacité
Référence de l’API REST
Parcourez l’API pour les comptes, Cloud, dossiers, transformations, utilisateurs et webhooks.
Présentation
Une référence navigable issue du contrat OpenAPI 3.1.
OpenAPI 3.1
Télécharger OpenAPI 3.1Référence de l’API REST
Parcourez l’API pour les comptes, Cloud, dossiers, transformations, utilisateurs et webhooks.
| HTTP | Path | Présentation |
|---|---|---|
| GET | /auth/me | Renvoie l’utilisateur authentifié et les métadonnées sûres de la clé API. |
| GET | /account | Renvoie le compte, le revendeur, l’abonnement et la configuration Cloud effective. |
| PATCH | /account | Met à jour les informations de base du compte. |
| GET | /account/stats | Renvoie les totaux des services, du stockage, des versions et des vues. |
| GET | /cloud/settings | Renvoie la configuration Cloud disponible pour le rôle authentifié. |
| PATCH | /cloud/settings | Met à jour la configuration Cloud globale ou la base des sous-comptes selon le rôle. |
| GET | /cloud/catalog | Renvoie le catalogue autorisé de services, extensions et applications d’envoi. |
| GET | /cloud/services | Renvoie une liste paginée des services Cloud. |
| POST | /cloud/services | Crée un service Cloud modifiable. |
| POST | /cloud/files | Envoie un fichier après validation de l’extension, du MIME détecté, de la taille et de l’application par défaut. |
| GET | /cloud/services/{code} | Renvoie le détail d’un service Cloud. |
| PATCH | /cloud/services/{code} | Met à jour le nom, la visibilité, le payload, le dossier ou les étiquettes. |
| DELETE | /cloud/services/{code} | Place un service Cloud dans la corbeille. |
| GET | /cloud/services/{code}/content | Télécharge avec authentification le fichier original ou un résultat. |
| GET | /cloud/services/{code}/thumbnail | Renvoie Cloud services. |
| GET | /cloud/services/{code}/stats | Renvoie les vues, les provenances et l’activité récente du service. |
| POST | /cloud/services/{code}/move | Déplace un service Cloud vers un autre dossier. |
| GET | /cloud/folders | Renvoie les dossiers accessibles. |
| POST | /cloud/folders | Crée un dossier. |
| PATCH | /cloud/folders/{id} | Renomme, déplace ou modifie la visibilité d’un dossier. |
| DELETE | /cloud/folders/{id} | Place un dossier et son contenu dans la corbeille. |
| GET | /file-transformer/operations | Répertorie les 154 opérations publiques avec leurs formats et paramètres. |
| GET | /file-transformer/operations/{operation} | Renvoie le contrat d’une opération précise. |
| POST | /file-transformer/estimates | Valide l’entrée et estime les crédits avant l’exécution. |
| GET | /file-transformer/jobs | Renvoie les traitements de transformation asynchrones du compte. |
| POST | /file-transformer/jobs | Crée et met en file une transformation. |
| GET | /file-transformer/jobs/{id} | Renvoie l’état, la progression, la consommation et les résultats d’un traitement. |
| POST | /file-transformer/jobs/{id}/cancel | Annule un traitement encore en file d’attente. |
| POST | /file-transformer/jobs/{id}/retry | Crée une nouvelle tentative depuis un traitement échoué ou annulé. |
| GET | /users | Les administrateurs listent les utilisateurs ; les revendeurs listent leurs sous-comptes. |
| POST | /users | Crée un utilisateur ou un sous-compte. |
| GET | /users/{id} | Renvoie le détail d’un utilisateur gérable. |
| PATCH | /users/{id} | Met à jour un utilisateur gérable. |
| PATCH | /users/{id}/cloud-settings | Personnalise Cloud pour un utilisateur gérable. |
| GET | /webhooks | Renvoie les endpoints webhook du compte. |
| POST | /webhooks | Crée un endpoint webhook universel. |
| GET | /webhooks/{id} | Renvoie le détail d’un endpoint webhook. |
| PATCH | /webhooks/{id} | Met à jour l’URL, les événements ou l’état, ou renouvelle le secret. |
| DELETE | /webhooks/{id} | Supprime un endpoint webhook. |
| POST | /webhooks/{id}/test | Met en file une livraison de test vers l’endpoint. |
| GET | /webhooks/{id}/deliveries | Renvoie l’historique paginé des livraisons d’un endpoint. |
| POST | /webhook-deliveries/{id}/retry | Remet manuellement une livraison webhook en file. |
| GET | /ai/providers | Liste IA fournisseurs. |
| POST | /ai/estimates | Crée IA estimations. |
| GET | /ai/text/generations | Liste IA texte générations. |
| POST | /ai/text/generations | Crée IA texte générations. |
| GET | /ai/media/generations | Liste IA médias générations. |
| POST | /ai/media/generations | Crée IA médias générations. |
| GET | /plans | Liste offres. |
| POST | /plans/custom/estimates | Crée offres personnalisées estimations. |
| GET | /billing/usage | Renvoie facturation consommation. |
| GET | /billing/credit-consumptions | Liste facturation consommations de crédits. |
| GET | /billing/tariffs | Liste facturation tarifs. |
| GET | /billing/subscription | Renvoie facturation abonnement. |
| POST | /billing/subscriptions/plan/{plan} | Crée facturation abonnements. |
| POST | /billing/subscriptions/custom | Crée facturation abonnements personnalisées. |
| POST | /billing/subscriptions/{subscription}/renew | Renouvelle facturation abonnements. |
| DELETE | /billing/subscriptions/{subscription} | Supprime facturation abonnements. |
| GET | /billing/transactions | Liste facturation transactions. |
| GET | /billing/transactions/{id} | Renvoie facturation transactions. |
| POST | /billing/transactions/{id}/cancel | Annule facturation transactions. |
| POST | /billing/transactions/{id}/retry | Réessaie facturation transactions. |
| POST | /billing/transactions/{id}/reconcile | Rapproche facturation transactions. |
| GET | /billing/invoices | Liste facturation factures. |
| GET | /billing/invoices/{invoice} | Renvoie facturation factures. |
| GET | /billing/invoices/{invoice}/pdf | Renvoie facturation factures. |
| GET | /cloud/services/{code}/versions | Liste Cloud versions. |
| GET | /cloud/services/{code}/versions/{version}/download | Renvoie Cloud versions. |
| POST | /cloud/services/{code}/versions/{version}/restore | Restaure Cloud versions. |
| GET | /cloud/services/{code}/permissions | Renvoie Cloud services autorisations. |
| PUT | /cloud/services/{code}/permissions | Met à jour Cloud services autorisations. |
| GET | /cloud/folders/{folder}/permissions | Renvoie Cloud dossiers autorisations. |
| PUT | /cloud/folders/{folder}/permissions | Met à jour Cloud dossiers autorisations. |
| GET | /cloud/imports/providers | Liste Cloud importations fournisseurs. |
| GET | /cloud/imports/connections | Liste Cloud importations connexions. |
| GET | /cloud/imports/{provider}/authorization | Renvoie Cloud importations autorisation. |
| POST | /cloud/imports/{provider}/connections | Crée Cloud importations connexions. |
| DELETE | /cloud/imports/connections/{provider} | Supprime Cloud importations connexions. |
| GET | /cloud/imports/{provider}/browse | Renvoie Cloud importations. |
| POST | /cloud/imports/{provider}/jobs | Crée Cloud importations. |
| GET | /cloud/import-jobs | Liste Cloud tâches d’importation. |
| GET | /cloud/import-jobs/{job} | Renvoie Cloud tâches d’importation. |
| GET | /cloud/services/{code}/survey/responses | Liste Cloud enquête réponses. |
| GET | /cloud/services/{code}/poll/results | Renvoie Cloud vote résultats. |
| GET | /cloud/services/{code}/event/attendees | Liste Cloud événement participants. |
| PATCH | /cloud/services/{code}/event/attendees/{attendee} | Met à jour Cloud événement participants. |
| GET | /cloud/services/{code}/signature/tracking | Renvoie Cloud signature suivi. |
| GET | /marketplace/services | Liste marketplace services. |
| GET | /marketplace/services/{service} | Renvoie marketplace services. |
| POST | /marketplace/services/{service}/installations | Crée marketplace installations. |
| DELETE | /marketplace/services/{service}/installations | Supprime marketplace installations. |
| POST | /marketplace/installations/{installation}/launch | Lance marketplace installations. |
| GET | /marketplace/partner/services | Liste marketplace partenaire services. |
| POST | /marketplace/partner/services | Crée marketplace partenaire services. |
| PUT | /marketplace/partner/services/{service} | Met à jour marketplace partenaire services. |
| DELETE | /marketplace/partner/services/{service} | Supprime marketplace partenaire services. |
| POST | /marketplace/partner/services/{service}/submit | Renvoie marketplace partenaire services. |
Fonctionnalités
Ce que permet Référence de l’API REST
Authentification étendue
Chaque opération protégée identifie la portée de moindre privilège requise par son itinéraire.
Nouvelles tentatives d'écriture sécurisées
Les clés d'idempotence protègent les écritures prises en charge contre la duplication accidentelle après les tentatives réseau.
Transformations asynchrones
Créez, estimez, surveillez, annulez et réessayez les tâches File Transformer.
Livraison d'événement signée
Créez des points de terminaison de webhook, inspectez les livraisons et réessayez les échecs transitoires.
Portée fonctionnelle explicite
Les éditeurs spécialisés, les réponses aux enquêtes, la gestion des participants, les signatures et la génération d'IA ne sont pas impliqués sauf si un point de terminaison est répertorié.
Questions fréquentes
Questions sur Référence de l’API REST
Non. La référence est la liste faisant autorité ; les opérations d'éditeur non répertoriées et spécifiques au service restent des flux de travail d'interface de compte.
Oui. Le JSON OpenAPI 3.1 reste disponible pour les générateurs, la validation et les outils locaux.
Utilisez une clé API à portée étroite et une clé d'idempotence pour les opérations d'écriture prises en charge.