概述 - 火星数据

火星数据API简介

火星数据API 向开发者提供 HTTP 和 websocket 两种协议的接口，开发者可通过这些接口获取各种类型的数据服务，返回结果支持 JSON 格式。

我们推荐根据应用场景来选择获取数据的协议（也可以混合使用），主要通过http获取数据，数据变化频率不高的使用http协议，数据变化频率高的类似实时数据通过websocket获取。

火星数据API 对所有用户开放。使用本组服务之前，需要申请app_id和app_secret，不同类型用户可获取不同的数据访问能力。

HTTP 协议

全局请求参数

PARAM	VALUE
base_url *	https://api.marzdata.cn
app_id	控制台获取，用于身份校验
app_secret	商务申请获得，用于权限校验

全局接口都支持http和https，每个接口都需要传app_id和app_secret，用来验证接口权限，使用白名单ip来请求才能获取到数据（不支持代理模式）

全局响应结构

PARAM	VALUE
code	状态码
data	主要返回数据
msg	请求状态

websocket协议

ws连接参数

PARAM	VALUE
base_url *	wss://ws.marzdata.cn
app_id	控制台获取，用于身份校验
app_secret	商务申请获得，用于权限校验

全局websocket地址都支持ws和wss，每个websocket都需要传app_id和app_secret，用来验证websocket权限，使用白名单ip来订阅才能获取到数据（不支持代理模式）

全局响应结构

PARAM	VALUE
channel	推送类型
push_type	推送类型（新增new；变化update）
data	主要返回数据
push_time_millis	推送时间，毫秒级时间戳

账号与密钥申请#

注册成为火星数据开发者需要分四步：

第 1 步，注册成为开发者；
注册后，请进入控制台绑定商务人员。

第 2 步：完成实名认证
在控制台-账户管理模块，根据自身类型，可选择个人方式认证或企业认证。针对个人和企业，提供的服务调用量有差别，如果您需要更高频次的服务调用，可联系商务升级您的账号。

第 3 步：联系商务开通权限
联系商务，申请想要试用的产品，开通试用后，在控制台即可生成app_id和app_secret以及开通试用权限的产品。

第 4 步：配置IP白名单
在控制台-访问管理，设置访问IP，每个客户最多可设置3个访问IP（正式环境、测试环境、预发布环境）。

SDK接入DEMO

我们提供JAVA、PHP和GOlang的接入DEMO_SDK，其他语言可以自行实现，详见接入指南。

使用限制

接入限制

除了动画直播和嵌入组件外，其他接口和推送都不可以直接应用到前端，所有数据都需要用户拉取到自己服务器上，再开发接口接入自己产品前端使用。

请求限速

每分钟请求频率总数：1200次（同一app_id）。
单个API请求频次数：每个接口有单独的请求频次限制，详见具体接口说明。
详见接入指南。

ws连接限数

同一份数据，同一个IP，只允许一个客服端连接在线。
所有websocket连接断开后，休息几秒再重新连接，不可一直重复连接。
单个API请求频次数：每个接口有单独的请求频次限制，详见具体接口说明
详见接入指南。

注意事项

1、为了更好的服务用户，我们基础的服务调用量有基本限制，如果您需要更高服务调用，可到联系商务升级您的账号。

2、本产品仅限用户自己使用，严禁分享或者售卖给其他人

3、使用本产品必须严格遵守当地的法律法规，我们对违法行为0容忍，您应确保您的应用以及对本服务、相关内容、相关数据、相关产品及任何本产品的使用行为和目的不违反所有适用的法律、法规、规章、规范、政策、行政命令、监管要求、国家强制性标准以及具有法律约束力的其他标准（统称为“法律法规”）的规定。如有违反，本产品随时中断服务并且所有责任都有由用户自己承担。

概述

火星数据API简介#

HTTP 协议#

全局请求参数#

全局响应结构#

websocket协议#

ws连接参数#

全局响应结构#

账号与密钥申请##

SDK接入DEMO#

使用限制#

接入限制#

请求限速#

ws连接限数#

注意事项#

火星数据API简介

HTTP 协议

全局请求参数

全局响应结构

websocket协议

ws连接参数

全局响应结构

账号与密钥申请#

SDK接入DEMO

使用限制

接入限制

请求限速

ws连接限数

注意事项