API Documentation
In der Sandbox ausführen

Schnellstart: Datei-Konvertierungs-API#

Dieses Schnellstart-Tutorial führt dich durch deine erste Dateikonvertierungs-Anfrage mit der EnConvert-API: Mit /v1/convert/url-to-pdf erfasst du eine Webseite als PDF. In drei Schritten registrierst du dich, erzeugst einen privaten API-Key und sendest eine Anfrage mit cURL, Python oder JavaScript. Dazu kommt ein multipart/form-data-Datei-Upload-Beispiel für JSON zu XML. Erfolgreiche Konvertierungen liefern eine presigned_url zum Herunterladen der konvertierten Datei, zusammen mit Speicher- und Timing-Metadaten.

In 3 Schritten loslegen#

  1. Registrieren -- Erstelle ein Konto auf enconvert.com, um deinen API-Key zu erhalten.
  2. API-Key holen -- Navigiere zum Dashboard und erzeuge einen privaten Key (sk_...). Kopiere ihn und bewahre ihn sicher auf.
  3. Erste Anfrage stellen -- Nutze die Beispiele unten, um eine Datei oder URL zu konvertieren.

Beispiel: URL zu PDF konvertieren#

Nutze den Endpunkt /v1/convert/url-to-pdf, um jede Webseite als PDF-Dokument zu erfassen.

cURL#

curl -X POST https://api.enconvert.com/v1/convert/url-to-pdf \
  -H "X-API-Key: YOUR_PRIVATE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com", "direct_download": false}'

Antwort#

Eine erfolgreiche Konvertierung liefert die Download-URL, den Speicherpfad und Metadaten:

{
  "presigned_url": "https://econverter.nyc3.cdn.digitaloceanspaces.com/...",
  "object_key": "live/files/12345/url-to-pdf/example_20250202_120530123.pdf",
  "filename": "example_20250202_120530123.pdf",
  "file_size": 45678,
  "conversion_time_seconds": 3.21
}
  • presigned_url -- Eine temporäre, herunterladbare URL für die konvertierte Datei.
  • object_key -- Der Speicherpfad der Datei (z. B. live/files/12345/url-to-pdf/...).
  • filename -- Der generierte Dateiname.
  • file_size -- Die Größe der konvertierten Datei in Bytes.
  • conversion_time_seconds -- Wie lange die Konvertierung gedauert hat.

Beispiel: Datei konvertieren (JSON zu XML)#

Lade eine Datei zur Konvertierung per multipart/form-data hoch.

cURL#

curl -X POST https://api.enconvert.com/v1/convert/json-to-xml \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "[email protected]" \
  -F "direct_download=false"

Antwort#

{
  "presigned_url": "https://econverter.nyc3.cdn.digitaloceanspaces.com/...",
  "object_key": "live/files/12345/json-to-xml/data_20250202_120530123.xml",
  "filename": "data_20250202_120530123.xml",
  "file_size": 1024,
  "conversion_time_seconds": 0.45
}

Python-Beispiel#

Nutze die requests-Bibliothek, um eine URL in ein PDF zu konvertieren:

import requests

response = requests.post(
    "https://api.enconvert.com/v1/convert/url-to-pdf",
    headers={"X-API-Key": "YOUR_API_KEY"},
    json={"url": "https://example.com"}
)

result = response.json()
pdf = requests.get(result["presigned_url"]).content

with open("output.pdf", "wb") as f:
    f.write(pdf)

JavaScript (Node.js) Beispiel#

Nutze die eingebaute fetch-API (Node.js 18+) oder einen beliebigen HTTP-Client:

const fs = require("fs");

const formData = new FormData();
formData.append("file", new Blob([fs.readFileSync("input.json")]), "input.json");
formData.append("direct_download", "true");

const response = await fetch("https://api.enconvert.com/v1/convert/json-to-xml", {
  method: "POST",
  headers: { "X-API-Key": "YOUR_API_KEY" },
  body: formData,
});

const buffer = Buffer.from(await response.arrayBuffer());
fs.writeFileSync("output.xml", buffer);

Häufig gestellte Fragen#

Wie bekomme ich einen API-Key für die EnConvert Datei-Konvertierungs-API?#

Erstelle ein Konto auf enconvert.com, navigiere dann zum Dashboard und erzeuge einen privaten Key (sk_...). Kopiere ihn und bewahre ihn sicher auf. Du sendest ihn bei jeder Anfrage im Header X-API-Key.

Wie konvertiere ich eine URL mit cURL in ein PDF?#

Sende eine POST-Anfrage an https://api.enconvert.com/v1/convert/url-to-pdf mit deinem Key im Header X-API-Key und einem JSON-Body wie {"url": "https://example.com", "direct_download": false}. Die Antwort ist JSON; lade die PDF über die enthaltene presigned_url. Setzt du direct_download stattdessen auf true, kommen die PDF-Bytes im Response-Body zurück und --output output.pdf speichert die Datei direkt.

Wie lade ich eine Datei zur Konvertierung über die REST-API hoch?#

Lade die Datei als multipart/form-data hoch, z. B. -F "[email protected]" in cURL gegen /v1/convert/json-to-xml. Das Node.js-Beispiel macht dasselbe mit FormData und der eingebauten fetch-API (Node.js 18+).

Was enthält die Antwort bei einer erfolgreichen Konvertierung?#

Die JSON-Antwort enthält presigned_url (eine temporäre, herunterladbare URL für die konvertierte Datei), object_key (den Speicherpfad), filename, file_size in Bytes und conversion_time_seconds.

Kann ich eine URL in Python in ein PDF konvertieren?#

Ja. Nutze die requests-Bibliothek, um per POST an https://api.enconvert.com/v1/convert/url-to-pdf mit dem Header X-API-Key und einem JSON-Body mit der url zu senden, lies dann presigned_url aus der JSON-Antwort und lade die Datei darüber herunter.

Nächste Schritte#

  • Authentifizierung behandelt private Keys, öffentliche Keys mit JWT und wie du die gerade erstellten Zugangsdaten überprüfst.
  • Endpunkte listet jede aufrufbare Route auf und die Parameter, die sie gemeinsam nutzen.
  • Synchrone und asynchrone Jobs erklärt, wann eine Anfrage das Ergebnis direkt zurückgibt und wann sie dir einen Job zum Abfragen übergibt.
← Introduction Authentication →