Skip to main content

OpenAPI 使用指南

第一步: 获取API Key与APP ID

API Key 是调用整套 ADP OpenAPI 的全局身份凭证,用于校验调用方企业 / 账号访问权限,所有接口发起请求时都必须携带该凭证鉴权,无合法 API Key 的请求会被网关直接拦截。 APP ID 是 ADP 内单个应用的唯一标识,用于区分你要操作、调用的目标应用,在文档抽取、工作流执行、应用配置类接口中作为核心业务入参,确定能力归属。

如何获取API Key?

你需要前往 ADP 平台 获取 API Key。点击个人头像后,进入 我的 API 查看令牌。或者点击需要调用的应用卡片右上角的”…”
Screenshot 20260618 120010

如何获取APP ID?

方法一:前往 ADP 平台 点击需要调用的应用卡片右上角的”…”,即可查看到 APP ID 和 API Key 方法二:通过接口查询名下完整应用列表,应用列表查询接口:查询应用列表或应用配置
Image
Image

第二步:完成接口身份认证

调用 ADP 工作流、文档抽取、文档解析、应用管理、积分查询全部接口,均需在请求头携带 X-API-KEY 完成身份校验。

第三步:配置接口基础访问地址(BaseURL)

所有接口统一网关地址为

接口参考

你可以在左侧导航的 ADP API 下查看所有接口。每个接口页面包含请求参数、响应结构和调用示例。也可以在顶部搜索栏查询需要调用的接口

文件传入方式

ADP支持两种文件传入方式,file_urlfile_base64 二选一即可
  • file_url:线上文件 URL。仅支持 HTTP 开头的地址。
  • file_base64:本地文件的 Base64 内容。
ADP 为用户免费提供 获取文件URL接口 ,可上传本地文件至 ADP 服务器。