丹林莫语 · 帮助文档

API 对接说明(客户版)使用指南与说明

深化指南系列 · API 对接的客户版说明,与《接口对接说明》互为补充

API 对接说明(客户版)

客户文档库 · 深化指南系列 · API 对接的客户版说明,与《接口对接说明》互为补充

本件与《接口对接说明》(c2_04)射程互斥:那一篇讲「这件事值不值得谈」,本件讲「决定谈了之后,大致怎么走」。

一、API 对接是什么

用一句话说:让两套系统直接说话,不用人来回搬运。

您平时用我们的平台,是打开页面、看简报、点按钮。API 对接的意思是,让您自己那套系统(比如门店管理系统、会员系统)直接来取数据、递任务,中间省掉手工环节。

举个身边的例子:您店里本来每天有人把平台上的简报抄进自己的表格里。对接之后,这个动作由系统自己做,人只看结果。

二、我们能开放什么

先把丑话说在前面:开放范围因客户而异,一单一议,以书面约定为准。这篇说明不列任何具体清单,因为清单本身就是对谈的内容。

大体上分三类:

每一类开放到什么深度、什么频率、什么范围,都在书面约定里写清楚,没有写的一律不做。

三、数据怎么流动

对接之后,数据走向是您看得见的:

一句话:数据不因为对接而变宽,还是只围着您这一家转。

四、安全上守住的几条

五、实话实说

API 对接不是买回来就完事的东西,它需要两边的人坐下来,把要什么、给什么、多久给一次,一条一条谈清楚,再动手。周期长短取决于约定的范围,我们不预支时间表。

另外,对接解决的是「搬运省人力」,不解决「内容本身好不好」。内容质量还是靠平台本身的工作,这两件事别混在一起指望。

六、想开始谈,怎么走

跟您的对接人说一声,我们安排。谈之前建议您先想清楚三件事:哪几个数据您真的每天要用、您那边的系统谁负责、万一暂时不通您这边的备用做法是什么。这三件事想清楚了,谈起来就快。

透明交付 · 证据说话