开放平台

目的

系统对接涉及不同系统之间的数据交互,通过不同方式的数据传递来达到某种业务目的。

本平台提供不同的接口和对接方式,让其他需要本平台数据的应用系统可以按各自的需要获得数据。

参与方

  • 本平台系统(统称平台
  • 相关应用系统(统称应用

对接方式

系统对接分两种:

  • 应用发起:应用按需调用平台提供的HTTP接口(下称:主动方式)
  • 平台发起:平台按需调用应用提供的HTTP接口(下称:回调方式)

目前只支持HTTP对接方式。

主动方式

应用直接调用HTTP接口,接口输入和输出格式以JSON为主。

主动方式,接口分两种:

  • 查询接口:对平台读取数据
  • 交易接口:对平台写入数据

对交易接口(写),需要达到幂等性要求,当应用发起一个交易请求时,需要生成一个唯一交易号, 当网路等原因导致报文可能丢失,应用需要用同一个交易号发起重发。平台则会以幂等处理,以防止重复交易。 具体在个别接口文档中会有详细说明。

对查询接口(读),则没有幂等性处理必要。

任何主动方式的请求,应用都需要附上一个有效授权HTTP头信息(Authorization)。没有附上有效授权头信息, 平台会返回HTTP状态401。有关获取有效授权,请看基本要求

回调方式

应用若需要接收平台的回调信息,需要在平台开发者界面注册回调地址,并做相关配置,才能获得相应的数据推送。

有关平台提供的回调方法和具体数据格式,请参考各个对接业务文档。