手机报接口V0.9.0文档示例:移动端与PC端JSON约定与安全通信

需积分: 25 24 下载量 64 浏览量 更新于2024-09-10 收藏 81KB DOC 举报
本资源是一份开放接口文档案例,主要针对移动端和PC端的接口设计规范,版本为V0.9.0,由马成龙于2014年11月27日创建。文档详细规定了接口的规则和约定,旨在确保数据传输的一致性和准确性。 1. 接口规则与约定: - 数据格式:服务器返回的数据必须采用JSON格式,所有的字段值都是字符串,如"{'data': '0'}",空字段表示为"\"\""。 - 字段命名:字段名遵循驼峰命名法,无论是客户端发送的请求字段还是服务器响应的JSON结构中的字段。 - 常见字段:每个接口返回的JSON结构都包含'data'、'status'和'info'三个字段,分别表示数据实体、结果码(0表示错误,1表示成功)和提示信息。 - 请求字段:客户端请求必须包含'appKey'和'reqType',分别用于应用识别和API方法标识。 - 经纬度表示:经纬度采用负值表示西经和南纬,例如"-23.4236"代表西经23.4236度。 2. 客户端与服务器通信: - 使用HTTP短连接协议进行数据交互,以POST方式提交数据。 - 对涉及用户隐私的通信,会切换到更安全的HTTPS协议,同样以POST方式传输数据。 3. 公共头信息: - 所有的接口请求都需要携带特定的公共头信息,如weblogid(类似于sessionID,由服务器返回)、screenSize(设备屏幕尺寸)和platform(设备平台,如'iP')等。第一次调用请求可能还需额外的初始化参数。 这份文档的目的是为了标准化开发流程,确保不同客户端之间的兼容性,并强调数据处理和安全方面的注意事项。遵循这些规则,开发者在构建移动端和PC端应用程序时可以更加高效地与服务器进行通信,并确保数据的准确解析和处理。