对接文档

把 appkey、itemid、请求参数与联调入口放到一条顺手的接入路径里。

文档入口围绕注册开通、鉴权说明、项目列表、参数示例、错误处理和联调动作展开,帮助开发者更快上线。

appkey 鉴权itemid 路由请求参数在线联调

从拿到 appkey 到完成第一次请求

先看 appkey 鉴权、itemid 对应项目、main / title 等请求字段,再继续进入示例、错误码和在线联调。

文档入口围绕 appkey、itemid、main、title 等当前稳定字段假设组织。
把快速开始、项目说明、参数示例、错误处理和在线调试拆成清晰栏目。
未确认的接口字段会明确标注,避免客户按错误信息接入。
文档模块

先按接入动作分区,再进入具体细节。

入口页优先帮开发者判断自己下一步该看哪里,而不是一上来就埋进长文。

快速开始

先完成第一次请求准备

帮助开发者先理解 appkey、itemid 和请求图像字段,再进入项目细节。

鉴权说明

围绕 appkey 组织鉴权入口

把客户真正会先用到的鉴权动作讲清楚,减少接入前的反复确认。

项目列表

按 itemid 区分识别项目

不同识别类型、价格和字段说明按项目集中展示,不让信息散落。

请求示例

参数示例更直观

后续会补充常见请求结构、返回字段和错误处理示例。

在线联调

调试入口单独承接

在线联调会承接项目选择、参数输入与结果查看,不和正文搅在一起。

支持说明

错误处理更好查

错误码、异常说明和排查建议会整理成统一入口,方便开发者快速定位问题。

接入流程

把第一次接入最常走的路线先整理好。

从注册、项目选择到参数准备和联调排错,路径越清楚,联调就越省时间。

01

注册并获取 appkey

从账号开通开始进入正式接入准备,避免文档和实际使用脱节。

02

选择 itemid 与项目

按识别类型查看项目说明、价格和对应参数要求,明确每个项目的调用方式。

03

准备 main / title 等参数

围绕主图、辅助图和其他必要字段完成请求组装,再进入联调验证。

04

查看结果与排错

联调阶段通过示例、错误码和在线调试入口快速定位问题。

文档原则

让文档既实用,也足够可信。

文档不仅要能看,还要能拿来真接入。任何未确认的字段都会显式说明。

实用性

先给开发者可执行动作

优先回答“第一步做什么、下一步去哪里”,而不是堆砌大段空话。

可信度

未确认字段明确标注

凡是后端还没确认的接口字段,都显式写成待确认,不装成熟接口。

效率

示例、调试、错误码互相支撑

让开发者从阅读到联调再到排错都走同一条清晰路径。

立即开始

准备接入时,先把项目、参数和价格都看明白。

如果你正准备开始联调,可以先注册开通账号;如果你想先确认项目价格,再继续看定价页。