架构说明

本文档旨在详细介绍开放平台的架构设计，包括API网关、数据响应结构、常用状态码概览以及协议与接口等方面的内容。通过本文档，开发者可以全面了解开放平台的运作机制，从而更好地进行接口开发和集成。

API网关

定义与功能:

1. 定义：API网关是连接数据“消费者”与数据“生产者”之间的桥梁。
2. 功能：统一提供接口的认证、授权、限流、熔断等通用功能，并以代理方式转发经过授权的请求。

架构图

作用与意义

1. 接口平台：作为最大的数据“生产者”，基于集成的数据提供各类基础数据接口。
2. 生态丰富：欢迎其他业务与接口平台进行接口集成，提供贴近业务的集成接口，丰富开放生态。

数据响应结构

鉴于API网关的统一策略，实际业务接口以代理方式请求后端API，返回的数据响应结构使用以下响应结构风格：

{
    "code": "A00000",
    "msg": "成功",
    "data": [
 
    ]
}

常用状态码概览

如何解决常见问题？👉

协议与接口

遵循标准

开放平台遵循OAuth2标准协议，并基于此模式授权提供RESTFUL风格的接口

RESTFUL文档

RESTFUL相关文档参考：https://restful.p2hp.com/ 

定制需求

除本文档公开的接口列表和授权协议外，我们也支持其他协议的接入和接口的定制。如有此类定制需求，请单独联系我们。