Overview
本部分内容主要介绍 LongPort OpenAPI 的基础信息,包括如何访问 API、如何使用 API、如何获取 API 接口文档等,内容比较原始。
提示
建议可以直接采用 SDK 的方式访问 API,SDK 已经封装了 API 的调用方式,使用起来更加方便。
API 须知
注意事项 | 参考文档 |
---|---|
推荐使用各自语言的 SDK,而不是调用原生的接口 | SDK 快速开始页面 |
阅读 OpenAPI 介绍中开通相应服务 | OpenAPI 如何开通 |
阅读 OpenAPI 介绍中使用权限及限制 | OpenAPI 使用权限及限制 |
了解通用错误码,便于查找调用接口出错的原因 | 通用错误码 |
REST API 文档约定格式
服务端 REST API 文档格式主要如下:
Request:
Request Info
Parameters
Request Example
Response:
Response Headers
Response Example
Response Status
Request Info
介绍调用 API 所需要的请求方式、路径。
- HTTP URL:服务端 API 的 URL。
- HTTP Method:服务端 API 仅支持 HTTP 协议的方法,如 GET、POST 等。
Parameters
介绍调用 API 所需传递的请求头部,查询参数或者请求体。
提示
GET 请求时默认所有参数为查询参数,非 GET 请求时默认所有参数都是请求体,请求体格式为 JSON。
Request Example
使用 SDK 调用接口的详细例子。
Response
- Response Headers: 返回内容头部信息。
- Response Example: 返回内容的文本示例。
- Response Status: 接口返回内容中的
status
的具体解释。