Pano开发者中心
  • 开发者中心
  • 下载中心

›RESTful API

新手入门

  • 简介
  • 名词解释
  • 创建第一个应用

规则说明

  • Channel ID命名规则
  • 权限控制
  • 计费说明
  • 频道最大时长说明
  • 每月一万分钟免费说明
  • 布局参数说明
  • 水印

场景方案

    教育行业

    • 1vN互动小班课
    • 互动直播大班课

快速接入

  • 简介
  • 音视频

    • Windows (C++)
    • iOS (Objective-C)
    • Android (Java)
    • Web
    • Electron
    • Flutter
    • React Native
    • Unity

    白板

    • Windows (C++)
    • iOS (Objective-C)
    • Android (Java)
    • Web
    • Electron
    • Flutter
    • React Native

高级功能(RTC)

  • 简介
  • 屏幕共享
  • 分组讨论
  • 状态回调
  • 设备诊断
  • 音量指示
  • 控制声音
  • 声卡操作
  • 混音/伴音
  • 混响
  • 耳返
  • 变声
  • 美颜
  • 音视频数据回调
  • 音视频外部采集
  • 收发多路视频
  • 多窗口渲染
  • 性能检测
  • 截图
  • 反馈

高级功能(RTS)

  • 简介
  • 白板

    • Windows (C++)
    • iOS (Objective-C)
    • Android (Java)
    • Web
    • Flutter

    标注

    • 视频标注
    • 共享标注
    • 外部标注

    消息

    • 消息服务

    远程控制

    • 远程控制

操作实践

  • 切换大小屏

RESTful API

  • 基本格式
  • 生成Token
  • 频道管理
  • 云端录制
  • CDN推流
  • 文档转码
  • 消息服务
  • 服务端消息通知

SDK API

  • SDK接口说明
  • Windows (C++)
  • macOS/iOS (Objective-C)
  • Android (Java)
  • Web SDK (IE专用版)
  • Web SDK

    • 浏览器兼容性
    • RtcEngine
    • GroupManager
    • RtcWhiteboard
    • RtsService
    • RtcMessage
    • Annotation
    • Constants

更新记录

  • 简介
  • Windows
  • macOS
  • iOS
  • Android
  • Electron
  • Flutter
  • React Native
  • Unity
  • Web(全功能SDK)
  • Web(RTS SDK)
  • Web(IE专用音视频SDK)

帮助

  • FAQ
  • 更多帮助

基本格式

Pano Cloud提供了一组RESTful API用于申请Token、录制、CDN推流等。HTTP请求示例:

POST /path/to/resource
Host: api.pano.video
Content-Type: application/json
Authorization: PanoSign <PanoSign>
Tracking-Id: ef9b2acc8e1f4d598090eb6d9cbe8596

{
  ...... // JSON string
}

HTTP协议

必须为HTTPS协议,不支持HTTP协议。

HTTP method

遵循RESTful最佳实践,使用标准的HTTP 方法来对应 CRUD 操作:

  • GET:读取(Read)
  • POST:新建(Create)
  • PUT:更新(Update)
  • PATCH:更新(Update),通常是部分更新
  • DELETE:删除(Delete)

根据 HTTP 规范,动词一律大写。

Host

Host必须为api.pano.video。

Content-Type

Content-Type必须为application/json,表示请求和响应都为JSON数据格式。

Authorization

所有请求里都必须带上Authorization请求头,类型为PanoSign,后面带上具体的PanoSign值。Pano服务器端使用PanoSign进行权限校验,关于PanoSign的格式和如何校验PanoSign请参考权限控制。

下面是一个Authorization头的例子:

Authorization: PanoSign e7d3fb36131345f0a922b27c8c5c2019.1570498816.c31f97d3797de14f9d8e2c17f3ab165f070f9dc6547aadb5e9706763dc29a0c8

Tracking ID

这是一个可选的请求头,但是建议开发者在请求头中带上 Tracking-Id 方便后续协助排查问题,值可以为 UUID 等唯一值。

返回状态码

HTTP 状态码是一个三位数,分成五个类别。

  • 1xx:相关信息
  • 2xx:操作成功
  • 3xx:重定向
  • 4xx:客户端错误
  • 5xx:服务器错误
HTTP状态码错误码描述
200正常返回
400App.Name.Duplicated应用名称重复
403Exceed.Limit新增超出限制
403Callback.Error回调不可达
403Perm.NotAllowed操作不允许,请检查功能是否开通
403Authorization.Type.InvalidHTTP请求头Authorization类型不对
403Authorization.Signature.InvalidHTTP请求头Authorization 值有误,请检查signature签名信息
403Org.Status.Error公司信息状态不对,请检查是否欠费
403App.Status.Error应用状态不对
403Invalid.Parameter.Value请求参数不合法,请检查是否按文档规定传递参数
404InvalidEntity.NotFound信息找不到,请查看入参是否正确
406Sign.Error请检查Authorization的credentials 部分 是否按照规定生成签名信息
500Server.Error服务器内部错误

每个API的详细格式请参考对应文档,部分请求出现错误时的返回示例如下:

403 AuthorizationTypeError
{
  "error": "Authorization.Type.Invalid",
  "msg": "your authorization type is invalid"
}
403 AuthorizationSignatureError
{
  "error": "authorization.Signature.Invalid",
  "msg": "your authorization signature is invalid"
}
403 AppStatusError
{
  "error": "App.Status.Error",
  "msg": "your app status is not correct"
}
403 OrgStatusError
{
  "error": "Org.Status.Error",
  "msg": "your organization status is abnormal"
}
403 PermNotNotAllowed
{
  "error": "Perm.NotAllowed",
  "msg": "The function needs to be opened, please contact technical support"
}
404 EntityNotFoundError
{
  "error": "InvalidEntity.NotFound",
  "msg": "could not find this entity"
}
406 AppSecretEmptyError
{
  "error": "App.Secret.Empty",
  "msg": "your appSecret is empty"
}
406 PanoSignError
{
  "error": "Sign.Error",
  "msg": "fix your signature value"
}
500 ServerError
{
  "error": "Server.Error",
  "msg": "server error, please contact the administrator"
}
Last updated on 1/25/2022
← 切换大小屏生成Token →
  • HTTP协议
  • HTTP method
  • Host
  • Content-Type
  • Authorization
  • Tracking ID
  • 返回状态码
浙ICP备20002645号 ©2019-2022 Pano拍乐云