什么是用户预定义参数

月萌API接口在调用过程中,存在三种参数:请求参数、用户预定义参数、返回参数,其中用户预定义参数属于特殊的请求参数。

在某些场景下,比如调用第三方接口,需要在请求过程中传入第三方平台的比如key信息,这个key信息比较固定,为了避免每次对月萌API的请求都重复传入,同时避免在传输过程中造成信息泄露,提前将这些类型的参数(根据每个接口的需求设定)保存在月萌API系统中的用户预定义参数中,在月萌API接口调用过程中自动按需取出组装为第三方接口的请求参数。

用户预定义参数如何设置

用户预定义参数是订阅级的,即仅在某个订阅ID下有效,在订阅接口后,通过个人中心->订阅列表->详情->用户预定义参数中设置。注意重新订阅某接口后,需要再次设定用户预定义参数。

如需修改,亦在个人中心->订阅列表->详情->用户预定义参数中修改。

如图:选择1处用户预定义参数设置,再选择2进行不同接口接入点的参数预设:

yscs.png

用户预定义参数注意事项

当前对于用户预定义参数的设置和修改,均需手动完成,因此仅适合对固定不变的参数进行预设置的场景。

用户预定义参数的优先级低于请求参数,即在接口支持的情况下,请求参数与用户预定义参数同时包含了某参数,将以请求参数的传入值为准,即使是空值。

当前仅部分接口根据实际的业务需求,支持设定用户预定义参数,若非实际需要,则不包含设定用户预定义参数功能。