Authentifizierung

Alle API-Anfragen erfordern eine Authentifizierung über einen API-Schlüssel, der als Bearer-Token im Authorization-Header gesendet wird.

API-Schlüssel

API-Schlüssel identifizieren Ihr Konto und erfassen die Nutzung im Verhältnis zu Ihren Tariflimits. Jeder Schlüssel hat vollen Zugriff auf die API-Funktionen Ihres Kontos.

Einen API-Schlüssel erstellen

Erzeugen Sie API-Schlüssel über Ihr Dashboard. Sie können mehrere Schlüssel erstellen und sie jederzeit einzeln widerrufen.

Ihren API-Schlüssel verwenden

Fügen Sie Ihren API-Schlüssel in den Authorization-Header jeder Anfrage ein:

cURL

curl -X POST https://api-parse.conversiontools.io/v1/extract \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@document.pdf"

Python

import requests

API_KEY = "YOUR_API_KEY"
headers = {"Authorization": f"Bearer {API_KEY}"}

with open("document.pdf", "rb") as f:
    response = requests.post(
        "https://api-parse.conversiontools.io/v1/extract",
        headers=headers,
        files={"file": f},
    )

data = response.json()
print(data["data"])

Node.js

const fs = require("fs");

const API_KEY = "YOUR_API_KEY";
const headers = { Authorization: `Bearer ${API_KEY}` };

const form = new FormData();
form.append("file", fs.createReadStream("document.pdf"));

const response = await fetch("https://api-parse.conversiontools.io/v1/extract", {
  method: "POST",
  headers,
  body: form,
});

const data = await response.json();
console.log(data.data);

Fehlerantworten

401 Unauthorized

Wird zurückgegeben, wenn der API-Schlüssel fehlt oder ungültig ist.

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}

403 Forbidden

Wird zurückgegeben, wenn der API-Schlüssel gültig ist, aber keine Berechtigung für die angeforderte Ressource hat.

{
  "success": false,
  "error": {
    "code": "FORBIDDEN",
    "message": "API key does not have access to this resource"
  }
}

Bewährte Sicherheitspraktiken

Speichern Sie API-Schlüssel in Umgebungsvariablen, niemals im Quellcode
Geben Sie API-Schlüssel niemals in die Versionsverwaltung (fügen Sie sie zur .gitignore hinzu)
Verwenden Sie getrennte API-Schlüssel für Entwicklung und Produktion
Wechseln Sie Schlüssel regelmäßig und widerrufen Sie alle, die möglicherweise offengelegt wurden
Legen Sie API-Schlüssel niemals im clientseitigen Code offen - rufen Sie die API immer von Ihrem Server aus auf