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日志中查看所有交付尝试。
每个解析器可以设置多个Webhook吗?
可以!配置多个Webhook URL,同时将提取的数据发送到不同的系统。
Webhook交付有超时限制吗?
Webhook请求在30秒后超时。您的端点应快速响应,并在需要时异步处理数据。
我可以筛选哪些文档触发Webhook吗?
可以!根据提取的数据值、文档类型或自定义标准设置条件性Webhook。
如果我需要调试Webhook问题该怎么办?
查看显示请求/响应数据、时间和错误消息的详细交付日志。在开发过程中,使用测试功能发送示例载荷。
