Вебхуки и API Airparser
Отправляйте извлечённые данные документов в любую систему с помощью вебхуков. Уведомления в реальном времени, мгновенные интеграции, полный контроль для разработчиков.
Подключайтесь к любой системе
Вебхуки позволяют получать уведомления в реальном времени при обработке документов. Отправляйте извлечённые данные напрямую в свои кастомные приложения, внутренние системы или любой сервис, принимающий HTTP POST-запросы.
Идеально для разработчиков, которым нужен полный контроль над процессами обработки документов и которые хотят интегрировать Airparser с проприетарными системами, кастомными базами данных или архитектурами микросервисов.
Зачем использовать вебхуки?
Как это работает
1. Документ получен
Документ отправлен в Airparser по email, загрузке или через API
2. ИИ извлекает данные
ИИ Airparser извлекает структурированные данные из документа
3. Запускается вебхук
HTTP POST отправляется на ваш эндпоинт с данными JSON
4. Ваша система обрабатывает
Ваше приложение получает и обрабатывает данные
Как создать вебхук в Airparser
Посмотрите это краткое руководство по настройке вебхуков в Airparser, чтобы начать получать уведомления о данных в реальном времени.
Пример полезной нагрузки вебхука
При обработке документа Airparser отправляет полезную нагрузку JSON на URL вашего вебхука:
{
"parser_id": "parser_abc123",
"document_id": "doc_xyz789",
"timestamp": "2024-01-15T10:30:00Z",
"extracted_data": {
"invoice_number": "INV-2024-001",
"invoice_date": "2024-01-10",
"vendor": "Acme Corporation",
"total_amount": 1250.00,
"currency": "USD",
"line_items": [
{
"description": "Professional Services",
"quantity": 10,
"unit_price": 125.00,
"total": 1250.00
}
]
},
"document_url": "https://airparser.com/documents/doc_xyz789",
"confidence": 0.98
}Сценарии использования вебхуков
Кастомные базы данных
Отправляйте извлечённые данные напрямую в PostgreSQL, MySQL, MongoDB или любую кастомную систему баз данных.
Внутренние системы
Интегрируйтесь с проприетарными ERP, CRM или внутренними бизнес-приложениями.
Микросервисы
Запускайте процессы микросервисов и конвейеры распределённой обработки.
Уведомления в реальном времени
Отправляйте мгновенные оповещения в кастомные системы уведомлений, мобильные приложения или дашборды.
Аналитика и отчётность
Передавайте извлечённые данные в инструменты бизнес-аналитики и платформы аналитики.
Кастомная автоматизация
Стройте сложные кастомные процессы автоматизации под вашу конкретную бизнес-логику.
Возможности вебхуков
Безопасная доставка
Шифрование HTTPS, опциональные подписи вебхука для верификации, поддержка белого списка IP.
Автоматические повторы
Неудачные доставки вебхука автоматически повторяются с экспоненциальной задержкой.
Журналы доставки
Просматривайте подробные журналы всех доставок вебхука, ответов и попыток повтора.
Тестовый режим
Протестируйте эндпоинт вебхука на тестовых данных перед обработкой реальных документов.
Кастомные заголовки
Добавляйте кастомные HTTP-заголовки для аутентификации, маршрутизации или метаданных.
Формат JSON
Чистая структурированная полезная нагрузка JSON, которую легко парсить и интегрировать.
Настройка вебхуков
Создайте эндпоинт вебхука
Настройте HTTP-эндпоинт в своём приложении, принимающий POST-запросы. Это может быть любой веб-сервер, serverless-функция или API-эндпоинт.
Настройте в Airparser
В настройках парсера добавьте URL вашего вебхука. Опционально настройте кастомные заголовки и аутентификацию.
https://yourdomain.com/webhook/airparserПротестируйте интеграцию
Используйте функцию тестирования, чтобы отправить тестовую полезную нагрузку на ваш эндпоинт и убедиться, что всё работает корректно.
Обрабатывайте входящие данные
Разберите полезную нагрузку JSON в своём приложении и обработайте извлечённые данные документа согласно вашей бизнес-логике.
Вернуть ответ 200 OK
Ваш эндпоинт должен возвращать код статуса 200 для подтверждения получения. Ответы, отличные от 200, запускают автоматические повторы.
Пример обработчика вебхука
Простой пример на Node.js/Express для обработки вебхуков Airparser:
const express = require('express');
const app = express();
app.use(express.json());
app.post('/webhook/airparser', (req, res) => {
const data = req.body;
console.log('Received data:', data.extracted_data);
// Process the extracted data
// e.g., save to database, trigger workflow, etc.
// Return 200 to acknowledge receipt
res.status(200).json({ received: true });
});
app.listen(3000, () => {
console.log('Webhook server running on port 3000');
});Доступ к RESTful API
В дополнение к вебхукам Airparser предоставляет полноценный RESTful API для программного доступа ко всем функциям.
Загрузка документов
Отправляйте документы на обработку через API-эндпоинты
Получение результатов
Получайте извлечённые данные с помощью GET-запросов
Управление парсерами
Создавайте и настраивайте парсеры программно
Проверка статуса
Отслеживайте статус обработки и историю
Часто задаваемые вопросы
Какие HTTP-методы поддерживаются?
Вебхуки используют HTTP POST-запросы с полезной нагрузкой JSON. Ваш эндпоинт должен принимать POST-запросы и возвращать код статуса 2xx.
Как защитить свой эндпоинт вебхука?
Используйте HTTPS, проверяйте подписи вебхука, реализуйте белый список IP или требуйте API-ключи в кастомных заголовках. Airparser поддерживает все эти методы аутентификации.
Что происходит, если мой эндпоинт недоступен?
Airparser автоматически повторит неудачные доставки до 5 раз с экспоненциальной задержкой. Все попытки доставки можно просмотреть в журналах вебхука.
Можно ли иметь несколько вебхуков на парсер?
Да! Настройте несколько URL вебхуков, чтобы одновременно отправлять извлечённые данные в разные системы.
Есть ли тайм-аут для доставки вебхука?
Запросы вебхука истекают через 30 секунд. Ваш эндпоинт должен быстро отвечать и при необходимости обрабатывать данные асинхронно.
Можно ли фильтровать, какие документы запускают вебхуки?
Да! Настройте условные вебхуки на основе значений извлечённых данных, типов документов или кастомных критериев.
Что делать, если нужно отладить проблемы с вебхуком?
Просматривайте подробные журналы доставки с данными запроса/ответа, временем и сообщениями об ошибках. Используйте функцию тестирования для отправки тестовых полезных нагрузок во время разработки.
Стройте кастомные интеграции с вебхуками
Получите полный контроль разработчика с вебхуками и API Airparser. Бесплатный пробный период, банковская карта не требуется.
