API-Referenz

Eine REST-API zur Extraktion strukturierter Daten aus Dokumenten. Senden Sie eine Datei, erhalten Sie strukturiertes JSON zurück.

Kostenlosen API-Schlüssel holen →Vollständige Dokumentation ansehen →Postman Postman-Sammlung
REST-APIJSON-AntwortenWebhooks60+ Sprachen

Authentifizierung

Alle Anfragen erfordern einen X-API-Key -Header. Holen Sie sich Ihren Schlüssel unter Einstellungen → API in Ihrem Airparser-Konto.

cURL
curl https://api.airparser.com/inboxes \
  -H "X-API-Key: YOUR_API_KEY"

Bewahren Sie Ihren API-Schlüssel sicher auf — behandeln Sie ihn wie ein Passwort.

Dokumente parsen

Laden Sie eine beliebige Datei hoch und erhalten Sie vollständig extrahierte Daten in einer einzigen synchronen Anfrage zurück — keine Webhooks, kein Polling, kein zweiter Aufruf. Die Antwort enthält alle extrahierten Felder als strukturiertes JSON, sofort einsatzbereit in Ihrem Workflow.

POST/inboxes/{inbox_id}/upload-syncAPI-Dokumentation →
curl \
  -X POST \
  https://api.airparser.com/inboxes/<INBOX_ID>/upload-sync \
  -F 'file=@./receipt.pdf' \
  -H "X-API-Key: <YOUR_API_KEY>"import requests

header = {"X-API-Key": "<API_KEY>"}
url = "https://api.airparser.com/inboxes/<INBOX_ID>/upload-sync"

with open('invoice.pdf', 'rb') as f:
    files = {'file': f}
    with requests.request("POST", url, files=files, headers=header) as response:
        print('response: ', response)const fetch = require("node-fetch");
const fs = require("fs");
const FormData = require("form-data");

const APIKEY = "<YOUR_API_KEY>";
const inboxId = "<INBOX_ID>";
const filePath = "/path/to/your/file.pdf";
const metadata = { foo: "bar" };

async function parseDocument(inboxId, filePath, metadata) {
  const url = `https://api.airparser.com/inboxes/${inboxId}/upload-sync`;

  const fileStream = fs.createReadStream(filePath);

  const form = new FormData();
  form.append("file", fileStream);
  form.append("meta", JSON.stringify(metadata));

  try {
    const response = await fetch(url, {
      method: "POST",
      body: form,
      headers: {
        "X-API-Key": APIKEY,
      },
    });

    const docId = await response.json();
    console.log(response.status);
    console.log("Document id:", docId);
  } catch (e) {
    console.error("Error:", e.message);
  }
}

parseDocument(inboxId, filePath, metadata);<?php

$apikey = '<API_KEY>';
$url = 'https://api.airparser.com/inboxes/<INBOX_ID>/upload-sync';
$filepath = './invoice.pdf';

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
    'X-API-Key: ' . $apikey
));
curl_setopt($curl, CURLOPT_POST, true);

$meta = array(
  'foo' => 'bar',
  'my_id' => 42,
);
$metaJson = json_encode($meta);

curl_setopt($curl, CURLOPT_POSTFIELDS, array(
    'file' => curl_file_create($filepath, 'application/pdf', 'invoice.pdf'),
    'meta' => $metaJson
));

$response = curl_exec($curl);
curl_close($curl);

echo $response;
Antwort200 OK
{
  "doc_id": "64abc123def456...",
  "parsing_in_progress": false,
  "status": "parsed",
  "name": "invoice.pdf",
  "content_type": "application/pdf",
  "created_at": "2026-03-10T12:00:00.000Z",
  "processed_at": "2026-03-10T12:00:04.321Z",
  "json": {
    "invoice_number": "INV-001",
    "vendor": "Acme Corp",
    "total": 1250.00,
    "currency": "USD",
    "date": "2024-01-15"
  }
}

Extrahierte Daten abrufen

Rufen Sie ein Dokument per ID ab, um seinen Extraktionsstatus und die Ergebnisse zu erhalten. Fragen Sie diesen Endpunkt ab oder nutzen Sie Webhooks, um zu wissen, wann die Verarbeitung abgeschlossen ist.

GET/documents/{document_id}
cURL
curl https://api.airparser.com/documents/doc_abc123 \
  -H "X-API-Key: YOUR_API_KEY"
Antwort200 OK
{
  "doc_id": "64abc123def456...",
  "parsing_in_progress": false,
  "status": "parsed",
  "name": "invoice.pdf",
  "content_type": "application/pdf",
  "created_at": "2026-03-10T12:00:00.000Z",
  "processed_at": "2026-03-10T12:00:04.321Z",
  "json": {
    "invoice_number": "INV-001",
    "vendor": "Acme Corp",
    "total": 1250.00,
    "date": "2024-01-15"
  }
}

Extraktionsschema definieren

Definieren Sie, welche Felder extrahiert werden sollen. Unterstützt skalare Felder, Listen (für Positionen) und Enums.

POST/inboxes/{inbox_id}/schema
{
  "fields": [
    {
      "type": "scalar",
      "data": {
        "name": "invoice_number",
        "description": "Invoice reference number",
        "type": "string",
        "default_value": ""
      }
    },
    {
      "type": "list",
      "data": {
        "name": "items",
        "description": "List of items in the invoice",
        "attributes": [
          {
            "name": "description",
            "description": "Item description",
            "type": "string",
            "default_value": ""
          },
          {
            "name": "amount",
            "description": "Item amount",
            "type": "decimal",
            "default_value": "0.00"
          }
        ]
      }
    },
    {
      "type": "enum",
      "data": {
        "name": "payment_status",
        "description": "Current payment status",
        "values": ["paid", "pending", "overdue"]
      }
    }
  ]
}

Nachbearbeitung

Führen Sie Python-Code auf extrahierten Daten aus, bevor sie an Integrationen gesendet werden. Fügen Sie Geschäftslogik hinzu, kombinieren Sie Felder, formatieren Sie Werte.

Felder zusammenführen
# Merge first and last name into full name
data['fullname'] = data['first_name'] + " " + data['last_name']

# Using f-strings (recommended)
data["fullname"] = f"{data['first_name']} {data['last_name']}"

# Using format() function
data['fullname'] = '{} {}'.format(data['first_name'], data['last_name'])
Bedingte Logik
# Only process invoices above certain amount
if float(data.get('total_amount', 0)) > 1000:
    data['priority'] = 'high'
else:
    data['priority'] = 'normal'

# Add timestamp
import datetime
data['processed_at'] = datetime.datetime.now().isoformat()

Entdecken Sie erweiterte Nachbearbeitungstechniken und Beispiele:

Nachbearbeitungsleitfaden →Codebeispiele →

Webhooks

Airparser sendet eine POST -Anfrage an Ihren Endpunkt, wenn die Extraktion abgeschlossen ist. Antworten Sie mit 200 zur Bestätigung.

Einrichtungsschritte

  1. 1 Kopieren Sie die URL Ihres Webhook-Endpunkts von Ihrem Server oder einem Dienst wie ngrok.
  2. 2 Gehen Sie zu Integrationen → Webhooks in Ihrem Airparser-Konto.
  3. 3 Klicken Sie auf „Create a webhook" und fügen Sie Ihre Endpunkt-URL ein.
  4. 4 Testen Sie den Webhook mit einem Beispieldokument, um die Integration zu überprüfen.
import json
from flask import Flask, request

app = Flask(__name__)

@app.route('/webhook', methods=['POST'])
def webhook():
    payload = request.data
    data = json.loads(payload)

    # Process the parsed data
    # data contains all extracted fields

    return {'success': True}

if __name__ == '__main__':
    app.run(port=4242)const express = require('express');
const app = express();

app.post('/webhook', express.raw({type: 'application/json'}), (request, response) => {
  const payload = request.body;
  const data = JSON.parse(payload);

  // Process the parsed data
  // data contains all extracted fields

  // Return 200 to acknowledge receipt
  response.send();
});

app.listen(4242, () => console.log('Running on port 4242'));<?php
$payload = @file_get_contents('php://input');
$data = json_decode($payload, true);

// Process the parsed data
// $data contains all extracted fields

// Always return 200 to acknowledge receipt
http_response_code(200);
echo "OK";

Ressourcen

Suchen Sie einen nicht-technischen Überblick? Lesen Sie Was ist eine Document Extraction API — behandelt das Konzept, Anwendungsfälle und wie die API von Airparser ohne Codebeispiele funktioniert.

Vollständige API-Dokumentation

Vollständige API-Referenz mit allen Endpunkten, Parametern und Beispielen.

Schnellstart

Folgen Sie unserer Schritt-für-Schritt-Anleitung, um in wenigen Minuten startklar zu sein.

Nachbearbeitungsleitfaden

Lernen Sie, extrahierte Daten mit Python-Skripten zu transformieren.