概述
API 简介
您可以通过调用我们提供的 API 完整地使用平台的功能。
我们提供的 API 是遵循 RESTful 原则进行设计的,允许您使用任何自己喜欢的编程语言与之交互。
目前,大部分 API 只接受内容为 application/json 格式的请求,同时使用 application/json 作为返回内容的格式。
注意:请求内容需要使用 UTF-8 进行编码,否则我们将无法对一些特殊字符进行解码。
您在平台页面上进行的所有操作,我们都有与之对应的 API ,因此您可以使用 API 来完成您在我们平台上的一切操作。
文档约定
本文将为您介绍 API 的调用方法、认证方式及 API 描述,帮助您快速了解如何使用我们提供的 API 开发您的应用。
在您阅读本文档之前,请先了解文档中的约定内容,以便您更好的使用我们提供的服务。
约定内容 | 说明 |
---|---|
{} 内参数为变量 | 在文档中该符号内参数为变量参数,在调用接口过程中,需要替换为实际环境的参数。例如:查看用户详情接口请求行 GET /apis/auth.example.io/v1/users/{name} ,其中的 {name} 需要在调用接口时替换为实际的用户名称。 |