Skip to content

API调用说明

Jump to bottom
chatop2020 edited this page Jan 12, 2021 · 5 revisions

AKStream WebApi接口说明

  • AKStream采用http restful 风格的WebApi接口提供给第三方应用对接集成
  • AKStream的http接口有鉴权认证功能，在调用AKStream WebApi接口时需要在http header上携带AccessKey，AccessKey的值被配置在配置文件中，具体详见配置文件章节介绍
  • 在http header上携带AccessKey的方式是KeyValue形式的如下所示： AccessKey=047I4WS1-U51UBO6W-1J4BT21P-MF17IT99-92J8WIHU-944Q4KIW
  • AccessKey会在首次运行并生成配置文件时自动生成，你也可以修改AccessKey的值，使之符合你的需求
  • AKStream的WebApi调用约定的方法有HttpGet和HttpPost两种，在向AKStream传递普通一般参数时（如基础类型参数）一般采用HttpGet方法，在向AKStream传递复杂参数时（如对象）一般采用HttpPost方法，具体接口采用了什么方式详见每个接口的具体说明
  • AKStream将接口按照功能集中程度分为以下几类
    1. AKStreamKeeper 这是专门针对AKStreamKeeper的API接口
    1. MediaServer 专门针对流媒体控制的API接口
    1. RecordPlan 针对录制计划模板的API接口
    1. SipServer 针对GB28181 Sip信令网关的API接口
    1. SystemService 针对系统层面的API接口
    1. WebHook 针对ZLMediaKit的回调而准备的API接口
  • AKStream还提供了Swagger API接口Web在线调试工具，可以通过http://ip:port/swagger 来访问它
  • 为了保障开发阶段的高效，AKStream的编译模式是Debug的情况下，不需要通过AccessKey鉴权认证；Release模式下则需要AccessKey鉴权认证
  • AKStream的WebApi中额外约定如下
    1. DateTime的格式化标准为 yyyy-MM-dd HH:mm:ss
    1. 涉及到枚举类型，可以传枚举的String值也可以传int值
Clone this wiki locally