请求/获取/推送/几种接口类型的示例

请求/获取/推送/几种接口类型的示例

请求数据的接口

接口名称

从XX系统请求XX数据的接口

接口描述

1、通常此类接口用于用户实时操作的场景,用户需要向平台请求数据,因此需要交代清楚用户做什么操作的时候调用此接口获取数据;

2、要获得平台接口的访问地址;

3、双方需要约定的数据唯一性维度、及数据重复的处理机制

请求参数

字段名称

对方要求传输的请求参数名称

(此名称是业务上的名字,非数据的字段名称,数据库的字段名称由开发根据此名称设计)

字段来源

字段的取值逻辑,取值来源

(此部分是重点,因为接口实现时工程师需要根据此描述给字段赋值)

示例


逻辑验证规则

对方系统对此字段的格式要求,缺省要求等验证规则。若不按此规则设计,则同步时对方不会接收数据,导致信息返回错误

返回参数

请求参数

传输给对方的请求参数,必传,用于识别是哪个参数获取到的数据

状态

数据获取成功与否的状态值

错误信息

返回失败时,返回失败原因,用于定位数据请求失败原因

返回参数

请求成功后获取的参数;若请求成功,返回参数不为空;拿到数据后为保证数据的完整性需要做规则校验;不满足校验规则时返回错误信息给对方;

供其他系统获取数据的接口

接口名称

供XX系统获取XX数据的接口

接口描述

1、对方系统访问此接口的业务场景;

2、一次性返回数据的数量(如单页、分页);

3、双方需要约定的数据唯一性维度、及数据重复的处理机制

请求参数

字段名称

对方请求数据时需要传输的参数

字段来源


示例

真实业务中字段的取值例子

逻辑验证规则

1、对是否缺省的定义;2、对阐述应该做的校验,如是否合法,及不满足条件时应该返回的错误信息

返回参数

对方请求参数

对方请求数据时需要传输的参数,必传,用于识别是哪个参数获取到的数据

状态

根据请求参数返回数据的状态值;若存在数据则返回成功值,若不存在则返回失败值

错误信息

返回失败时,返回失败原因,用于定位数据请求失败原因

返回参数

请求成功后返回给对方系统的数据;若请求参数有匹配到数据则返回,若匹配不到数据则返回控制

(此部分是重点,因为接口实现时工程师需要根据此描述给字段赋值)

接收数据的接口

接口名称

接收XX系统推送的XX数据的接口

接口描述

1、描述此接口的业务场景;

2、双方需要约定的数据唯一性维度、及数据重复的处理机制

请求参数

字段名称

对方请求数据时需要传输的参数

字段来源


示例

真实业务中字段的取值例子

逻辑验证规则

1、对是否缺省的定义;2、对阐述应该做的校验,如是否合法,及不满足条件时应该返回的错误信息

返回参数

状态

根据请求参数返回数据的状态值;若存在数据则返回成功值,若不存在则返回失败值

错误信息

返回失败时,返回失败原因,用于定位数据请求失败原因

返回参数

请求成功后返回给对方系统的数据;若请求参数有匹配到数据则返回,若匹配不到数据则返回控制

(此部分是重点,因为接口实现时工程师需要根据此描述给字段赋值)

推送数据的接口

接口名称

向XX系统推送的XX数据的接口

接口描述

1、描述此接口的业务场景;

2、对方接口的访问地址;

3、双方需要约定的数据唯一性维度、及数据重复的处理机制

请求参数

字段名称

对方请求数据时需要传输的参数

字段来源

字段的取值逻辑,取值来源

(此部分是重点,因为接口实现时工程师需要根据此描述给字段赋值)

示例

真实业务中字段的取值例子

逻辑验证规则

1、对是否缺省的定义;2、对阐述应该做的校验,如是否合法,及不满足条件时应该返回的错误信息

返回参数

状态

根据请求参数返回数据的状态值;若存在数据则返回成功值,若不存在则返回失败值

错误信息

返回失败时,返回失败原因,用于定位数据请求失败原因

0条评论 添加新讨论

登录后参与讨论
Ctrl+Enter 发表