OpenAPI User Guide
输入“/”快速插入内容
OpenAPI User Guide
OpenAPI User Guide
用户2938用户2938
用户3485用户3485
用户5952用户5952用户5429用户5429
用户7107用户71073月16日修改
API call
Application support within the ADP platform can be integrated into third-party applications via API.
Document Extraction (synchronous)
POST / open/agentic_doc_processor/[tenant_name]/v1/app/doc/extract
Call the specified Document Extraction application for the document uploaded by the user.
Header
name | type | Mandatory or not | description |
X-Access-Key | string | yes | Tenant's token for accessing OpenAPI |
X-Timestamp | string | yes | timestamp |
X-Signature | string | yes | Tenant authentication signature |
accept-language | string | No | Returns the language of the field names. The default value is 'zh', which returns Chinese field names; if set to 'en', it returns English field names |
Request
Response
name | type | description |
message | string | return message |
tips | string | Details |
code | string | Business code: success, error, ... |
data | object | Return data object |
|- task_id | string | Extract task ID |
|- file_url | string | Extract file URL |
|- status | int | Task status: 1 Waiting, 2 Analyzing, 3 Extracting, 4 Successful, 5 Failed |
|- doc_recognize_result | array | Document parsing results |
|- extraction_result | array | Field extraction results |
End to end interface testing script
Usage:
Usage
# file_url/file_base64: File URL or Base64
# base_url: Service address
# app_key: Application key
# app_secret: Application secret
# access_key: Tenant token
python3 call_doc_api.py --base_url=https://adp-global.laiye.com --file_url=xxx --app_key=xxx --app_secret=xxxx
End to end interface script call_deoc_mapi-py:
End to end interface script call_deoc_mapi-py
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
Document processing API call script
Call the document details API using the obtained request headers
"""
import argparse
import asyncio
import logging
import time
import uuid
from typing import Any
import aiohttp
# Configure Logging
logging.basicConfig(
level=logging.INFO,
format='%(asctime)s - %(levelname)s - %(message)s'
)
logger = logging.getLogger(__name__)
async def get_request_headers(access_key: str = '') -> dict[str, Any]:
"""
Get request headers
Args:
access_key: tenant-level key
Returns:
dict: Request Header
"""
logger.info("Start obtaining request headers")
# Simplified request header generation logic
headers = {
'X-Access-Key': f'{access_key}', # Directly use a fixed access_key
'X-Timestamp': f'{time.time()}',
'X-Signature': uuid.uuid4().__str__().replace("-", ""),
}
logger.info(f"Request headers generated successfully: {headers}")
return headers
async def call_doc_api(base_url: str, file_url: str, file_base64: str, app_key: str, app_secret: str, tenant_name: str = 'laiye', access_key: str = '') -> dict[str, Any]:
"""
Call the Document Details API
Args:
base_url: API base address
file_url: File URL
file_base64: File base64 encoding
app_key: App Secret
app_secret: App Secret
tenant_name: tenant name
access_key: tenant-level key
Returns:
dict: API response result
"""
# Get the request headers
headers = await get_request_headers(access_key=access_key)
# Construct the request URL
api_url = f"{base_url}/open/agentic_doc_processor/{tenant_name}/v1/app/doc/extract"
# Construct the request body
request_data = {
"app_key": app_key,
"app_secret": app_secret,
}
# If file_base64 is provided, add it to the request body
if file_base64:
request_data["file_base64"] = file_base64
if file_url:
request_data["file_url"] = file_url
logger.info(f"Call API: {api_url}")
logger.info(f"Request parameters: {request_data}")
async with aiohttp.ClientSession() as session:
try:
async with session.post(api_url, headers=headers, json=request_data) as response:
response_data = await response.json()
logger.info(f"API response status code: {response.status}")
logger.info(f"API response data: {response_data}")
return response_data
except aiohttp.ClientError as e:
logger.error(f"API call failed: {str(e)}")
return {"error": str(e)}
async def main():
"""main function"""
parser = argparse.ArgumentParser(description='Document processing API call script')
parser.add_argument('--base_url', default='https://adp.laiye.com', help='API base address')
parser.add_argument('--file_url', default='', help='File URL')
parser.add_argument('--file_base64', default='', help='File base64 encoding (optional)')
parser.add_argument('--tenant_name', default='laiye', help='tenant name')
parser.add_argument('--app_key', required=True, help='App Secret')
parser.add_argument('--app_secret', required=True, help='App Secret')
parser.add_argument('--access_key', required=True, help='tenant's auth key')
args = parser.parse_args()
try:
result = await call_doc_api(
base_url=args.base_url,
file_url=args.file_url,
file_base64=args.file_base64,
app_key=args.app_key,
app_secret=args.app_secret,
tenant_name=args.tenant_name,
access_key=args.access_key
)
print("\n" + "="*60)
print("API call completed")
print(f"Result: {result}")
print("="*60)
except Exception as e:
logger.error(f"Script execution exception: {str(e)}")
if __name__ == "__main__":
asyncio.run(main())