平台开放API文档

版本	更新内容	更新时间	修订人
1.0	api文档基础版	2025.09.09	金鑫

API列表

POST 发送短信验证码

POST /platform/openapi/sendCaptcha

{
  "phone": "12345678901"
}

请求参数 - POST 发送短信验证码

名称	位置	类型	必选	说明
» phone	body	String	是	手机号

{
      "status": true,
      "code": "200",
      "msg": "短信验证码发送成功",
      "res": null
}

返回结果 - POST 发送短信验证码

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 发送短信验证码

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		请求状态 true成功 false失败
» code	String	true	none		返回code 200成功 400失败
» res	String	true	none		返回参数
» msg	String	true	none		返回信息

POST 验证短信验证码

POST /platform/openapi/verificationCaptcha

{
  "phone": "12345678901",
  "captcha": 1234556
}

请求参数 - POST 验证短信验证码

名称	位置	类型	必选	说明
» phone	body	String	是	手机号
» captcha	body	String	是	验证码

{
  "status": true,
  "code": "200",
  "msg": "验证成功",
  "res": null
}

返回结果 - POST 验证短信验证码

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 验证短信验证码

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		请求状态 true成功 false失败
» code	String	true	none		返回code 200成功 400失败
» res	String	true	none		返回参数
» msg	String	true	none		返回信息

POST 注册新网账号

POST /platform/openapi/registerUser

{
  "userName": "新网数码",
  "phone": 12345674801,
  "email": "xinnet@xinnet.com"
}

请求参数 - POST 注册新网账号

名称	位置	类型	必选	说明
» userName	body	String	是	用户名
» phone	body	Integer	是	手机号
» email	body	String	是	企业邮箱

{
  "status": true,
  "code": "200",
  "msg": "账号注册成功",
  "res": "hy123456"
}

返回结果 - POST 注册新网账号

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 注册新网账号

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		请求状态 true成功 false失败
» code	String	true	none		返回code 200成功 400失败
» res	String	true	none		返回参数
» msg	String	true	none		返回信息

POST 获取免登票据

POST /platform/openapi/getLoginTicket

{
  "phone": "12345678901",
  "email": "xinnet@xinnet.com",
  "domain": "xinnet.com"
}

请求参数 - POST 获取免登票据

名称	位置	类型	必选	说明
» phone	body	String	是	手机号
» email	body	String	是	企业邮箱
» domain	body	String	是	域名

{
  "status": true,
  "code": "200",
  "msg": "获取票据成功",
  "res": "06025b07-d952-47e5-b7aa-ce5197269bad"
}

返回结果 - POST 获取免登票据

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构 - POST 获取免登票据

状态码 200

名称	类型	必选	约束	中文名	说明
» status	boolean	true	none		请求状态 true成功 false失败
» code	String	true	none		返回code 200成功 400失败
» res	String	true	none		返回参数
» msg	String	true	none		返回信息

Last modified: 25 April 2026