服务器 API 介绍¶
服务器 API 用于 LinkRTC 后台与用户的应用服务程序之间的通信。
它们之间的通信以 HTTP 的形式在互联网上进行。
LinkRTC 与 用户的应用服务程序 既充当 HTTP 服务器又充当 HTTP 客户端 ： 以客户端的身份向对方发送请求，同时也以服务器的身份接受对方的请求。
设计原则¶
格式规范¶
HTTP 地址¶
用户应用服务程序调用 LinkRTC 的 API 时候，URL 的路径部分的格式是:
/<api_version>/sapi/*
其中 api_version 是 LinkRTC API 的版本，跨版本访问可能有兼容问题。
sapi 表示服务应用程序接口（ Service Application Program Interface ），所有的服务器API的访问路径均具有该部分。
HTTP 头和内容¶
普通请求与回复¶
POST 或 PUT 请求、以及回复的正文部分 必须 是 采用 UTF-8 编码的 JSON 格式字符串， Content-Type 头域的值应是 application/json。
例如：
用户应用程序服务发出的请求：
POST /v0.l/sapi/client/create HTTP/1.1
Host: api.linkrtc.com
Content-Type: application/json; charset=utf-8
Content-Length: xxx
{
"name": "client-01",
"capability": {
"audio": true,
"video": false
}
}
api.linkrtc.com 的回复：
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: xxx
{
"id": "fg430mu3ojfg398u4"
}
空请求与回复¶
如果 POST 、 PUT 请求不包含内容，或回复不包含内容， 其 Content-Length 头域的值应为 0，例如：
请求：
POST /v0.1/sapi/ping HTTP/1.1
Host: api.linkrtc.com
Content-Length: 0
回复：
HTTP/1.1 200 OK
Content-Length: 0
HTTP 状态码¶
500 Internal Server Error¶
如果服务器在响应API调用期间出现错误，或者出现意料之外的情况，应返回该状态码。
LinkRTC 在许多情况下，会提供具体的错误编码以及错误信息，这些错误信息用 JSON 对象格式存放在回复数据的内容部分。
其中 code 属性记录错误编码， text 属性记录错误文本信息。
如：
HTTP/1.1 500 Internal Server Error
Content-Type: application/json; charset=utf-8
Content-Length: xxx
{"code": 10013, "text": "calee not allowed"}
注意
LinkRTC 后台服务无法在所有情况下都提供 JSON 格式错误信息。 调用方可以根据 Content-Type 进行判断。