Airparser Webhook＆API
Webhookであらゆるシステムに抽出したドキュメントデータを送信。リアルタイム通知、即座の連携、完全な開発者コントロール。
あらゆるシステムと接続
Webhookを使用すると、ドキュメントが処理されたときにリアルタイム通知を受け取ることができます。抽出データをカスタムアプリケーション、内部システム、またはHTTP POSTリクエストを受け付けるあらゆるサービスに直接送信できます。
ドキュメント処理ワークフローを完全に制御し、Airparserを独自システム、カスタムデータベース、マイクロサービスアーキテクチャと連携させたい開発者に最適です。
なぜWebhookを使うのか？
仕組み
1. ドキュメント受信
メール、アップロード、API経由でAirparserにドキュメントが送信される
2. AIがデータを抽出
Airparser AIがドキュメントから構造化データを抽出
3. Webhookがトリガーされる
JSONデータとともにHTTP POSTがエンドポイントに送信される
4. あなたのシステムが処理
アプリケーションがデータを受信・処理
AirparserでWebhookを作成する方法
この簡単なガイドを見て、Airparserでリアルタイムデータ通知を受け取るためのWebhookのセットアップ方法を学びましょう。
Webhookペイロードの例
ドキュメントが処理されると、AirparserはあなたのWebhook URLにJSONペイロードを送信します：
{
"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
}Webhookのユースケース
カスタムデータベース
抽出データをPostgreSQL、MySQL、MongoDB、またはあらゆるカスタムデータベースシステムに直接送信。
内部システム
独自のERP、CRM、内部ビジネスアプリケーションと連携。
マイクロサービス
マイクロサービスワークフローと分散処理パイプラインをトリガー。
リアルタイム通知
カスタム通知システム、モバイルアプリ、ダッシュボードに即座のアラートを送信。
分析・レポート
抽出データをビジネスインテリジェンスツールや分析プラットフォームに供給。
カスタム自動化
ビジネスロジックに合わせた複雑なカスタム自動化ワークフローを構築。
Webhookの機能
安全な配信
HTTPS暗号化、検証用のオプションのWebhook署名、IPホワイトリストのサポート。
自動再試行
失敗したWebhook配信は指数バックオフで自動的に再試行されます。
配信ログ
すべてのWebhook配信、レスポンス、再試行の詳細なログを表示。
テストモード
実際のドキュメントを処理する前に、サンプルデータでWebhookエンドポイントをテスト。
カスタムヘッダー
認証、ルーティング、メタデータ用のカスタムHTTPヘッダーを追加。
JSON形式
解析と連携が容易なクリーンで構造化されたJSONペイロード。
Webhookの設定
Webhookエンドポイントを作成
POSTリクエストを受け付けるHTTPエンドポイントをアプリケーションに設定。任意のWebサーバー、サーバーレス関数、またはAPIエンドポイントが使用できます。
Airparserで設定
パーサーの設定でWebhook URLを追加。任意でカスタムヘッダーと認証を設定できます。
https://yourdomain.com/webhook/airparser連携をテスト
テスト機能を使用してエンドポイントにサンプルペイロードを送信し、正しく動作していることを確認。
受信データを処理
アプリケーションでJSONペイロードを解析し、ビジネスロジックに従って抽出されたドキュメントデータを処理。
200 OKレスポンスを返す
エンドポイントは受信を確認するために200ステータスコードを返す必要があります。200以外のレスポンスは自動再試行をトリガーします。
Webhookハンドラーの例
AirparserのWebhookを処理するシンプルなNode.js/Expressの例：
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アクセス
Webhookに加えて、Airparserはすべての機能へのプログラムによるアクセスのための包括的なRESTful APIを提供します。
ドキュメントをアップロード
APIエンドポイント経由で解析用にドキュメントを送信
結果を取得
GETリクエストで抽出データを取得
パーサーを管理
プログラムでパーサーを作成・設定
ステータスを確認
処理状況と履歴を監視
よくある質問
どのようなHTTPメソッドに対応していますか？
WebhookはJSONペイロード付きのHTTP POSTリクエストを使用します。エンドポイントはPOSTリクエストを受け付け、2xxステータスコードを返す必要があります。
Webhookエンドポイントをどのように保護すればいいですか？
HTTPSを使用し、Webhook署名を検証し、IPホワイトリストを実装するか、カスタムヘッダーでAPIキーを要求してください。Airparserはこれらすべての認証方法をサポートしています。
エンドポイントがダウンした場合はどうなりますか？
Airparserは失敗した配信を指数バックオフで最大5回まで自動的に再試行します。Webhookログですべての配信試行を確認できます。
1つのパーサーに複数のWebhookを設定できますか？
はい！複数のWebhook URLを設定して、抽出データを異なるシステムに同時に送信できます。
Webhook配信にタイムアウトはありますか？
Webhookリクエストは30秒後にタイムアウトします。エンドポイントは迅速に応答し、必要に応じて非同期でデータを処理する必要があります。
どのドキュメントがWebhookをトリガーするかフィルタリングできますか？
はい！抽出データの値、ドキュメントタイプ、カスタム基準に基づいて条件付きWebhookを設定できます。
Webhookの問題をデバッグする必要がある場合は？
リクエスト/レスポンスデータ、タイミング、エラーメッセージを示す詳細な配信ログを表示。開発中はテスト機能を使用してサンプルペイロードを送信できます。
