Справочник API

REST API для извлечения структурированных данных из документов. Отправьте файл, получите структурированный JSON.

Получить API-ключ бесплатно →Смотреть полную документацию → Postman

Коллекция Postman

REST APIJSON-ответыВебхуки60+ языков

Аутентификация

Все запросы требуют заголовок X-API-Key . Получите ключ в разделе «Настройки → API» вашего аккаунта Airparser.

cURL

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

Храните API-ключ надёжно — относитесь к нему как к паролю.

Обработка документов

Загрузите любой файл и получите полностью извлечённые данные в одном синхронном запросе — без вебхуков, без опроса, без второго вызова. Ответ содержит все извлечённые поля в виде структурированного JSON, готового к немедленному использованию в вашем процессе.

POST/inboxes/{inbox_id}/upload-syncДокументация API →

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;

Ответ200 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"
  }
}

Получение извлечённых данных

Получите документ по ID, чтобы узнать статус извлечения и результаты. Опрашивайте этот эндпоинт или используйте вебхуки, чтобы узнать о завершении обработки.

GET/documents/{document_id}

cURL

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

Ответ200 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"
  }
}

Определение схемы извлечения

Определите, какие поля извлекать. Поддерживаются скалярные поля, списки (для позиций) и перечисления.

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

Пост-обработка

Запускайте код Python над извлечёнными данными перед отправкой в интеграции. Добавляйте бизнес-логику, объединяйте поля, форматируйте значения.

Объединение полей

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

Условная логика

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

Изучите продвинутые техники пост-обработки и примеры:

Руководство по пост-обработке →Примеры кода →

Вебхуки

Airparser отправляет запрос POST на ваш эндпоинт по завершении извлечения. Ответьте 200 для подтверждения.

Шаги настройки

1 Скопируйте URL эндпоинта вебхука со своего сервера или сервиса вроде ngrok.
2 Перейдите в раздел «Интеграции → Вебхуки» в вашем аккаунте Airparser.
3 Нажмите «Create a webhook» и вставьте URL эндпоинта.
4 Протестируйте вебхук на тестовом документе, чтобы проверить интеграцию.

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

Ресурсы

Ищете нетехнический обзор? Читайте Что такое API извлечения данных из документов — рассматривает концепцию, сценарии использования и то, как работает API Airparser, без примеров кода.

Полная документация API

Полный справочник API со всеми эндпоинтами, параметрами и примерами.

Быстрый старт

Следуйте нашему пошаговому руководству, чтобы начать работу за минуты.

Руководство по пост-обработке

Научитесь преобразовывать извлечённые данные с помощью скриптов Python.