OpenAPI als Quelle
Methoden, Pfade und Betriebsbeschreibungen stammen aus dem herunterladbaren OpenAPI-Vertrag.
Fähigkeit
REST-API-Referenz
Durchsuchen Sie die API für Konten, Cloud, Ordner, Transformationen, Benutzer und Webhooks.
Überblick
Die navigierbare Referenz wird aus demselben OpenAPI-3.1-Vertrag erzeugt.
OpenAPI 3.1
OpenAPI 3.1 herunterladenREST-API-Referenz
Durchsuchen Sie die API für Konten, Cloud, Ordner, Transformationen, Benutzer und Webhooks.
| HTTP | Path | Überblick |
|---|---|---|
| GET | /auth/me | Gibt den authentifizierten Benutzer und sichere Metadaten des API-Schlüssels zurück. |
| GET | /account | Gibt Konto, Reseller, Abonnement und wirksame Cloud-Einstellungen zurück. |
| PATCH | /account | Aktualisiert die grundlegenden Kontodaten. |
| GET | /account/stats | Gibt Summen für Dienste, Speicher, Versionen und Aufrufe zurück. |
| GET | /cloud/settings | Gibt die für die authentifizierte Rolle verfügbaren Cloud-Einstellungen zurück. |
| PATCH | /cloud/settings | Aktualisiert je nach Rolle globale Cloud-Einstellungen oder die Basis für Unterkonten. |
| GET | /cloud/catalog | Gibt den erlaubten Katalog für Dienste, Erweiterungen und Upload-Apps zurück. |
| GET | /cloud/services | Gibt eine paginierte Liste der Cloud-Dienste zurück. |
| POST | /cloud/services | Erstellt einen bearbeitbaren Cloud-Dienst. |
| POST | /cloud/files | Lädt eine Datei nach Prüfung von Erweiterung, erkanntem MIME-Typ, Größe und Standard-App hoch. |
| GET | /cloud/services/{code} | Gibt die Details eines Cloud-Dienstes zurück. |
| PATCH | /cloud/services/{code} | Aktualisiert Name, Sichtbarkeit, Payload, Ordner oder Tags. |
| DELETE | /cloud/services/{code} | Verschiebt einen Cloud-Dienst in den Papierkorb. |
| GET | /cloud/services/{code}/content | Lädt die Originaldatei oder ein Ergebnis authentifiziert herunter. |
| GET | /cloud/services/{code}/thumbnail | Gibt zurück Cloud Dienste. |
| GET | /cloud/services/{code}/stats | Gibt Aufrufe, Herkunft und letzte Aktivitäten des Dienstes zurück. |
| POST | /cloud/services/{code}/move | Verschiebt einen Cloud-Dienst in einen anderen Ordner. |
| GET | /cloud/folders | Gibt die zugänglichen Ordner zurück. |
| POST | /cloud/folders | Erstellt einen Ordner. |
| PATCH | /cloud/folders/{id} | Benennt einen Ordner um, verschiebt ihn oder ändert seine Sichtbarkeit. |
| DELETE | /cloud/folders/{id} | Verschiebt einen Ordner und seinen Inhalt in den Papierkorb. |
| GET | /file-transformer/operations | Listet alle 154 öffentlichen Vorgänge mit Formaten und Parametern auf. |
| GET | /file-transformer/operations/{operation} | Gibt den Vertrag eines bestimmten Vorgangs zurück. |
| POST | /file-transformer/estimates | Validiert die Eingabe und schätzt die Credits vor der Ausführung. |
| GET | /file-transformer/jobs | Gibt die asynchronen Transformationsaufträge des Kontos zurück. |
| POST | /file-transformer/jobs | Erstellt eine Transformation und stellt sie in die Warteschlange. |
| GET | /file-transformer/jobs/{id} | Gibt Status, Fortschritt, Verbrauch und Ergebnisse eines Auftrags zurück. |
| POST | /file-transformer/jobs/{id}/cancel | Bricht einen noch wartenden Auftrag ab. |
| POST | /file-transformer/jobs/{id}/retry | Erstellt einen neuen Versuch aus einem fehlgeschlagenen oder abgebrochenen Auftrag. |
| GET | /users | Administratoren listen Benutzer auf; Reseller listen ihre Unterkonten auf. |
| POST | /users | Erstellt einen Benutzer oder ein Unterkonto. |
| GET | /users/{id} | Gibt die Details eines verwaltbaren Benutzers zurück. |
| PATCH | /users/{id} | Aktualisiert einen verwaltbaren Benutzer. |
| PATCH | /users/{id}/cloud-settings | Passt Cloud für einen verwaltbaren Benutzer an. |
| GET | /webhooks | Gibt die Webhook-Endpunkte des Kontos zurück. |
| POST | /webhooks | Erstellt einen universellen Webhook-Endpunkt. |
| GET | /webhooks/{id} | Gibt die Details eines Webhook-Endpunkts zurück. |
| PATCH | /webhooks/{id} | Aktualisiert URL, Ereignisse oder Status oder rotiert das Geheimnis. |
| DELETE | /webhooks/{id} | Löscht einen Webhook-Endpunkt. |
| POST | /webhooks/{id}/test | Stellt eine Testzustellung an den Endpunkt in die Warteschlange. |
| GET | /webhooks/{id}/deliveries | Gibt den paginierten Zustellverlauf eines Endpunkts zurück. |
| POST | /webhook-deliveries/{id}/retry | Stellt eine Webhook-Zustellung manuell erneut in die Warteschlange. |
| GET | /ai/providers | Listet KI Anbieter. |
| POST | /ai/estimates | Erstellt KI Schätzungen. |
| GET | /ai/text/generations | Listet KI Text Generierungen. |
| POST | /ai/text/generations | Erstellt KI Text Generierungen. |
| GET | /ai/media/generations | Listet KI Medien Generierungen. |
| POST | /ai/media/generations | Erstellt KI Medien Generierungen. |
| GET | /plans | Listet Tarife. |
| POST | /plans/custom/estimates | Erstellt Tarife individuelle Schätzungen. |
| GET | /billing/usage | Gibt zurück Abrechnung Nutzung. |
| GET | /billing/credit-consumptions | Listet Abrechnung Credit-Verbrauch. |
| GET | /billing/tariffs | Listet Abrechnung Preise. |
| GET | /billing/subscription | Gibt zurück Abrechnung Abonnement. |
| POST | /billing/subscriptions/plan/{plan} | Erstellt Abrechnung Abonnements. |
| POST | /billing/subscriptions/custom | Erstellt Abrechnung Abonnements individuelle. |
| POST | /billing/subscriptions/{subscription}/renew | Verlängert Abrechnung Abonnements. |
| DELETE | /billing/subscriptions/{subscription} | Löscht Abrechnung Abonnements. |
| GET | /billing/transactions | Listet Abrechnung Transaktionen. |
| GET | /billing/transactions/{id} | Gibt zurück Abrechnung Transaktionen. |
| POST | /billing/transactions/{id}/cancel | Storniert Abrechnung Transaktionen. |
| POST | /billing/transactions/{id}/retry | Wiederholt Abrechnung Transaktionen. |
| POST | /billing/transactions/{id}/reconcile | Gleicht ab Abrechnung Transaktionen. |
| GET | /billing/invoices | Listet Abrechnung Rechnungen. |
| GET | /billing/invoices/{invoice} | Gibt zurück Abrechnung Rechnungen. |
| GET | /billing/invoices/{invoice}/pdf | Gibt zurück Abrechnung Rechnungen. |
| GET | /cloud/services/{code}/versions | Listet Cloud Versionen. |
| GET | /cloud/services/{code}/versions/{version}/download | Gibt zurück Cloud Versionen. |
| POST | /cloud/services/{code}/versions/{version}/restore | Stellt wieder her Cloud Versionen. |
| GET | /cloud/services/{code}/permissions | Gibt zurück Cloud Dienste Berechtigungen. |
| PUT | /cloud/services/{code}/permissions | Aktualisiert Cloud Dienste Berechtigungen. |
| GET | /cloud/folders/{folder}/permissions | Gibt zurück Cloud Ordner Berechtigungen. |
| PUT | /cloud/folders/{folder}/permissions | Aktualisiert Cloud Ordner Berechtigungen. |
| GET | /cloud/imports/providers | Listet Cloud Importe Anbieter. |
| GET | /cloud/imports/connections | Listet Cloud Importe Verbindungen. |
| GET | /cloud/imports/{provider}/authorization | Gibt zurück Cloud Importe Autorisierung. |
| POST | /cloud/imports/{provider}/connections | Erstellt Cloud Importe Verbindungen. |
| DELETE | /cloud/imports/connections/{provider} | Löscht Cloud Importe Verbindungen. |
| GET | /cloud/imports/{provider}/browse | Gibt zurück Cloud Importe. |
| POST | /cloud/imports/{provider}/jobs | Erstellt Cloud Importe. |
| GET | /cloud/import-jobs | Listet Cloud Importaufträge. |
| GET | /cloud/import-jobs/{job} | Gibt zurück Cloud Importaufträge. |
| GET | /cloud/services/{code}/survey/responses | Listet Cloud Umfrage Antworten. |
| GET | /cloud/services/{code}/poll/results | Gibt zurück Cloud Abstimmung Ergebnisse. |
| GET | /cloud/services/{code}/event/attendees | Listet Cloud Veranstaltung Teilnehmende. |
| PATCH | /cloud/services/{code}/event/attendees/{attendee} | Aktualisiert Cloud Veranstaltung Teilnehmende. |
| GET | /cloud/services/{code}/signature/tracking | Gibt zurück Cloud Signatur Nachverfolgung. |
| GET | /marketplace/services | Listet Marketplace Dienste. |
| GET | /marketplace/services/{service} | Gibt zurück Marketplace Dienste. |
| POST | /marketplace/services/{service}/installations | Erstellt Marketplace Installationen. |
| DELETE | /marketplace/services/{service}/installations | Löscht Marketplace Installationen. |
| POST | /marketplace/installations/{installation}/launch | Startet Marketplace Installationen. |
| GET | /marketplace/partner/services | Listet Marketplace Partner Dienste. |
| POST | /marketplace/partner/services | Erstellt Marketplace Partner Dienste. |
| PUT | /marketplace/partner/services/{service} | Aktualisiert Marketplace Partner Dienste. |
| DELETE | /marketplace/partner/services/{service} | Löscht Marketplace Partner Dienste. |
| POST | /marketplace/partner/services/{service}/submit | Gibt zurück Marketplace Partner Dienste. |
Funktionen
Was REST-API-Referenz ermöglicht
Bereichsbezogene Authentifizierung
Jeder geschützte Vorgang identifiziert den Bereich mit den geringsten Rechten, der für seine Route erforderlich ist.
Sichere Schreibwiederholungen
Idempotenzschlüssel schützen unterstützte Schreibvorgänge vor versehentlicher Duplizierung nach Netzwerkwiederholungsversuchen.
Asynchrone Transformationen
Erstellen, schätzen, überwachen, brechen Sie File Transformer-Jobs ab und wiederholen Sie sie.
Unterzeichnete Veranstaltungszustellung
Erstellen Sie Webhook-Endpunkte, überprüfen Sie Lieferungen und wiederholen Sie vorübergehende Fehler.
Explizite Funktionsumfang
Spezialisierte Redakteure, Umfrageantworten, Teilnehmerverwaltung, Signaturen und KI-Generierung sind nicht impliziert, es sei denn, ein Endpunkt ist aufgeführt.
Häufige Fragen
Fragen zu REST-API-Referenz
Nein. Die Referenz ist die maßgebliche Liste; Nicht aufgeführte Editor- und dienstspezifische Vorgänge bleiben Kontoschnittstellen-Workflows.
Ja. Der OpenAPI 3.1 JSON bleibt für Generatoren, Validierung und lokale Tools verfügbar.
Verwenden Sie einen API-Schlüssel mit engem Gültigkeitsbereich und einen Idempotenzschlüssel für unterstützte Schreibvorgänge.