API nuoroda

REST API struktūrizuotiems duomenims ištraukti iš dokumentų. Siųskite failą, gaukite struktūrizuotą JSON atgal.

Gauti API raktą nemokamai →Peržiūrėti pilną dokumentaciją → Postman

REST APIJSON atsakymaiWebhook'ai60+ kalbų

Autentifikavimas

Visoms užklausoms reikalinga X-API-Key antraštė. Gaukite savo raktą skiltyje Nustatymai → API savo Airparser paskyroje.

cURL

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

Saugokite savo API raktą saugiai — traktuokite jį kaip slaptažodį.

Analizuoti dokumentus

Įkelkite bet kokį failą ir gaukite atgal pilnai ištrauktus duomenis vienoje sinchroninėje užklausoje — jokių webhook'ų, periodinio tikrinimo ar antro iškvietimo. Atsakyme yra visi ištraukti laukai kaip struktūrizuotas JSON, paruoštas iš karto naudoti jūsų darbo eigoje.

POST/inboxes/{inbox_id}/upload-syncAPI dokumentacija →

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;

Atsakymas200 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"
  }
}

Gauti ištrauktus duomenis

Gaukite dokumentą pagal ID, kad sužinotumėte jo ištraukimo būseną ir rezultatus. Periodiškai tikrinkite šį galutinį tašką arba naudokite webhook'us, kad žinotumėte, kada apdorojimas baigtas.

GET/documents/{document_id}

cURL

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

Atsakymas200 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"
  }
}

Apibrėžti ištraukimo schemą

Apibrėžkite, kokius laukus ištraukti. Palaiko skaliarinius laukus, sąrašus (eilučių elementams) ir išvardijimus.

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"]
      }
    }
  ]
}

Apdorojimas po analizės

Vykdykite Python kodą ištrauktiems duomenims prieš juos siunčiant į integracijas. Pridėkite verslo logiką, sujunkite laukus, formatuokite reikšmes.

Sujungti laukus

# 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'])

Sąlyginė logika

# 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()

Susipažinkite su pažangiais apdorojimo po analizės metodais ir pavyzdžiais:

Apdorojimo po analizės vadovas →Kodo pavyzdžiai →

Webhook'ai

Airparser siunčia POST užklausą į jūsų galutinį tašką, kai ištraukimas baigtas. Atsakykite su 200 kad patvirtintumėte.

Sąrankos žingsniai

1 Nukopijuokite savo webhook galutinio taško URL iš savo serverio ar tokios paslaugos kaip ngrok.
2 Eikite į Integracijos → Webhook'ai savo Airparser paskyroje.
3 Spustelėkite "Sukurti webhook'ą" ir įklijuokite savo galutinio taško URL.
4 Išbandykite webhook'ą su pavyzdiniu dokumentu, kad patikrintumėte integraciją.

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";

Ištekliai

Ieškote netechninės apžvalgos? Skaitykite Kas yra dokumentų ištraukimo API — apima koncepciją, naudojimo atvejus ir tai, kaip Airparser API veikia be kodo pavyzdžių.

Pilna API dokumentacija

Išsami API nuoroda su visais galutiniais taškais, parametrais ir pavyzdžiais.

Greitas startas

Sekite mūsų žingsnis po žingsnio vadovą, kad pradėtumėte veikti per kelias minutes.

Apdorojimo po analizės vadovas

Išmokite transformuoti ištrauktus duomenis su Python skriptais.