API接口说明书(VSPP)#20040225
云讯科技开放平台产品接入操作指南API接口文档
开放平台操作指南
▪为开发者提供产品接入的测试调试、正式接入使用说明；
▪为降低开发者了解和测试平台功能的门槛，同时为防止平台被过分滥用，为每一位已注册开发者提供￥8元的账户初始资金，可使用该资金完整地体验平台产品。
产品接入流程
Account Sid
▪开发者在开放平台的唯一标示，在SDK登录、REST请求中使用；
▪开发者账号ID在网站注册后，系统自动生成，不可更改。
Auth Token
▪相当于开发者账号sid（Account Sid）的密码，在SDK登录、REST请求中使用；
▪初始的开发者Auth Token在网站注册后，系统自动生成；如果出现开发者Token泄露的情况，系统支持开发者重置Auth Token。
Rest URL
▪用户注册的默认身份为“注册用户”；
▪完成［个人开发者］或者［企业开发者］认证后，平台创建的应用可申请上线商用；
开发者用户注册完成后，账户默认有8元的初始测试资金，所有的产品消费金额从该账户余额进行扣取：
▪产品体验、测试均会消费账户余额；
▪可单独给指定短信帐号分配可消费金额，账户余额为0时，平台自动中止应用使用，请开发者预先设定余额提醒阈值（建议设置为平均每天消费金额的7倍），以便于余额不足及时给账户充值，保证产品可正常使用。
产品接入
创建/编辑应用。
vb api函数使用手册
vb api函数使用手册VB API（Application Programming Interface，应用程序编程接口）是一种供开发者使用的工具，它为开发者提供了一套标准的函数和方法，以便与特定软件或系统进行交互和通信。
VB API函数使用手册为开发者提供了相关的文档和说明，以帮助他们使用API中的函数进行编程。
以下是VB API函数使用手册的一些主要内容。
1.引言-简要介绍VB API及其作用；-提供VB API函数使用手册的目的和范围；-确定读者的预期水平和目标。
2.准备环境-提供VB API函数使用的开发环境和工具；-介绍如何安装和配置VB API；-提供示例代码和演示项目，以帮助开发者快速上手。
3. API函数基础知识-解释API函数的基本概念和术语；-介绍API函数的语法和参数；-提供示例代码，以帮助开发者理解和使用函数。
4. API函数列表-详细列出所有可用的API函数；-每个函数提供函数名称、参数说明和返回值说明；-提供示例代码，以帮助开发者了解函数的用途和使用方法。
5.常见问题和错误处理-列出开发者在使用API函数时常见的问题和错误；-提供解决方案和错误处理技巧；-提醒开发者注意事项和最佳实践。
6.附录-提供额外的参考资料和资源链接；-列出相关的文档和教程；-提供支持和联系信息，以便开发者获得进一步的帮助。
编写VB API函数使用手册时，需要注意以下几点：1.使用简单明了的语言和术语，以便开发者容易理解和掌握；2.提供丰富的示例代码和演示项目，以帮助开发者实际运用API函数；3.使用图表、表格和代码块等辅助工具，以提高可读性和易用性；4.按照逻辑顺序组织内容，以便开发者可以系统性地学习和参考。
总结：VB API函数使用手册是帮助开发者学习和使用VB API函数的重要工具。
它提供了必要的文档和说明，以帮助开发者理解API函数的用途和使用方法。
编写VB API函数使用手册需要使用简明清晰的语言，提供丰富的示例代码，并按照逻辑顺序组织内容，以便开发者可以轻松地掌握和应用API函数。
开心网API接口说明文档
开心网API接口说明文档以下是为大家整理的开心网ApI接口说明文档的相关范文，本文关键词为开心,ApI,接口,说明,文档,oauth,认证,获取,授权，您可以从右上方搜索框检索更多相关文章，如果您觉得有用，请继续关注我们并推荐给您的好友，您可以在综合文库中查看更多范文。
1.oauth认证①获取未授权的Requesttoken需要第三方应用程序的ApIKey和ApIsecrect才能在相应的接口地址申请未授权的Requesttoken。
ApIKey和ApIsecrect是第三方应用与开心网申请获得的，在使用Kaixin_android_sdk之前，先要把/kaixin_android_sdk/src/com/kaixin/connect/Kainxin.java中的consumeR_KeY和consumeR_secRecT替换成为你申请的ApIKey和ApIsecretKey。
示例代码：Kaixinkaixin=Kaixin.getInstance();Try{//获取未授权的RequestTokenIf(kaixin.getRequsetToken(context,”….”)){uriuri=uri(Kaixin.Kx_AuThoRIZe_uRL+”?oauth_token”+kaixin,getRequestToken() );startActivity(newIntent(…),uri);}}ApI提供了获得未授权的RequestToken的方法，就是getRequestToken();传两个参数，第一个是当前的上下文，第二个是callbackuRL(重定向的uRL地址)。
返回类型是boolean值，false就是没有申请成功。
②请求用户授权RequestTokenuri中的保存的是请求用户授权的接口地址。
（1）此页面中会要求用户登录，然后选择同意或者拒绝对应用授权。
（2）授权成功后:A:web应用会重定向到oauth_callback所指定的uRL（含返回参数）b:客户端应用(oauth_callback=oob)会在网页中给出授权码，用户需要手工将验证码输入到应用中才能完成授权流程。
商品API接口文档说明
产品接收服务端API 假如是wms推送过来的数据，编码格式：UTF-8WebService 采用Soap 方式其说明如下WebService地址http://192.168.1.100/api/soap/server.php一：推送商品。
function add_goods($goods=array())参数$goods = array()数组形式，如下：规则$goods = array('username' => 'sinoauwiner','password' => 'sinoauwiner1225128955','goods_name' => 'sinoauwiner','goods_title' => 'sinoauwiner','goods_sn' => 'A112-20220020020004','price' => '88.9','market_price' => '92.6','box_price' => '488.0','reco_price' => '75.0','brand' => 'sinoauwiner');username 双方协定用户名称password双方协定用户密码goods_name 商品名称goods_title 商品标题goods_sn 商品编号price 单价格market_price 销售、市场价格box_price 一箱价格reco_price 促销价格brand 品牌返回结果参数password_error 双方协定密码错误。
API接口说明书模板
API接口说明书Word模板API接口说明书某某系统接口说明书北京某某科技有限公司2020年7月目录某某系统接口说明书1引言1.1编写目的1.2范围1.3参考资料2APP接口说明2.1接口名称2.1.1请求地址2.1.2参数说明2.1.3返回结果说明2.1.4示例1引言1.1编写目的本报告的目的为了明确某某艺术馆App调用系统服务器的接口，为安排App的开发提供依据。
1.2范围本报告主要围绕App应用提出的基本需求，为下一步的App开发系统提供基础的API接口。
2APP接口说明2.1接口名称2.1.1请求地址2.1.3返回结果说明2.1.4示例URL：http://www.***.com/d/app/focusAd?type=1&locale=zh 返回结果：[{"id":18,"picUrl":"focusad/08f5c8d1-7671-4514-cfc0-7a76e4e64836.jpg","title":"独立风骨","type":1,"createtime":1434532509000,"effTs":14345325 09000,"des":"","isUsing":1,"sortNum":1,"toUrl":"http://w ww.***.com/guest/88242"},{"id":16,"picUrl":"focusad/fd e16538-50f1-48f6-ef14-b17c78772fa1.jpg","title":"华南理工大学","type":1,"createtime":1433154304000,"effTs":14331543 04000,"des":"舞跃华南","isUsing":1,"sortNum":1,"toUrl":"http://www.***com/c ontent/expoEvent16/1"},{"id":19,"picUrl":"focusad/b1782a75-429f-476f-cc75-8c3601e85ddb.jpg","title":"中央美术学院"}]。
vCloud_API说明书(中文整理版)
vCloud API 说明书：这个说明书总结的是在版本1.5的vCloud API下，用户可进行的操作。
协议：vCloud API浏览器请求的总结：浏览器请求提供在只读模式下进入一个云或者浏览器自身包含的对象。
1).API-URL形式像：https:///api。
2).id是唯一标识。
当你得到表示他们操作的对象时，请求的URLs保证可用。
URL表单只供参考用途。
表-2：vCloud API浏览器请求的总结操作请求请求主体返回为浏览器的操作检索一个列表的入口点[新]GET API-URL/Session 无200 ok检索你可以进入的一个列表的组织GET API-URL/org/id 无OrgList(组织列表)检索一个组织的内容GET API-URL/org/id 无Org检索一个网络的属性GET API-URL/network /id 无OrgNetwork检索一个目录的内容GET API-URL/catalog/id 无Catalog检索一个目录子项的属性GET API-URL/catalogItem/id 无CatalogItem检索一个vDC的内容GET API-URL/vdc/id 无Vdc检索一个媒体图片的属性GET API-URL/media/id 无Media检索一个vAPP的模板GETAPI-URL/vAppTemplate/vappTemplate-id无V AppTemplate检索一个vAPP的属性GET API-URL/vAPP/vapp-id 无V App检索一个虚拟机的属性GET API-URL/vAPP/vm-id 无VmvCloud API Provisioning（预配置）请求总结：预配置请求可为vDC和目录增加一个云应用的模板或者媒体。
你也可以利用预配置请求来复制、移动、重命名、删除这些对象。
1).API-URL形式像：https:///api。
2).id是唯一标识。
api接口说明文档模板文
api接口说明文档模板文api接口说明文档模板1正如在"什么是API"中所说,API函数包含在位于系统目录下的DLL文件中.你可以自己输入API函数的声明,但VB提供了一种更简单的方法,即使用API Text Viewer. 要想在你的工程中声明API函数,只需运行API Text Viewer,打开Win32api.txt(或.MDB如果你已经把它转换成了数据库的话,这样可以加快速度. 使用预定义的常量和类型也是同样的方法. API除了有应用“应用程序接口”的意思外，还特指 API的说明文档，也称为帮助文档。
你将会遇到一些问题假设你想在你的窗体模块中声明一个函数.粘贴然后运行,VB会告诉你:编译错误...Declare 语句不允许作为类或对象模块中的 Public 成员...看起来很糟糕,其实你需要做的只是在声明前面添加一个Private(如 Private Declare Function...).--不要忘了,可是这将使该函数只在该窗体模块可用. 在有些情况下,你会得到"不明确的名称"这样的提示,这是因为函数.常量或其他的什么东西共用了一个名称.由于绝大多数的函数(也可能是全部,我没有验证过)都进行了别名化,亦即意味着你可以通过Alias子句使用其它的而不是他们原有的名称,你只需简单地改变一下函数名称而它仍然可以正常运行.api接口说明文档模板文21、技术优势具有高效率、团结、富有创意的团队，技术实力雄厚，可针对不同层次客户的需求;2、服务优势领先的技术、严密的流程、品牌的保证，为在线交易给予有力的安全保障;庞大的客服体系，为您提供7×24小时不间断的客户服务;3、卡类兑换优势解决客户往返银行汇款的麻烦，提升客户效率，有效增加订单数量。
百汇通具有几十种的卡类兑换方式，与上游运营商合作密切，有大部分运营商充值接口，卡类产品的多样化能够满足所有客户的对于卡类兑换的需求。
API接口调用说明及示例(第四次修订)
产品/项目名称保密级别邮件系统机密产品/项目版本最后更新日期8103 2014-09-12 邮件系统V8接口文档北京亿中邮信息技术有限公司版权所有侵权必究仅供内部使用修订记录日期修订版本修改描述作者2012-11-15 0.1 初稿刘畅2013-10-21 0.2 初稿王永杰2014-04-22 0.3 更新错误的5值傅春花2014-09-12 0.4 重新编辑整理文档周盈妤目录1 接口简介--------------------------------------------------------- 错误！未指定书签。
2 认证概述--------------------------------------------------------- 错误！未指定书签。
2.1 认证方式的分类------------------------------------------- 错误！未指定书签。
2.2 认证方式的选择------------------------------------------- 错误！未指定书签。
2.3 认证原理 -------------------------------------------------- 错误！未指定书签。
3 认证方法详解及示例 --------------------------------------------- 错误！未指定书签。
3.1 ------------------------------------------------------------ 错误！未指定书签。
3.2 ------------------------------------------------------------ 错误！未指定书签。
3.2.1 的认证方法： -------------------------------------- 错误！未指定书签。
3.2.2 的认证方法： -------------------------------------- 错误！未指定书签。
企业短信平台企业API接口使用手册范文
企业短信平台企业API接口说明2006-12-6目录1 企业API接口............................................ 错误！未定义书签。
1.1 接口函数说明.................................... 错误！未定义书签。
1.1.1 发送消息函数SendMessage ........................ 错误！未定义书签。
1.1.2 接收消息函数RecvMessage ........................ 错误！未定义书签。
1.2 企业接口调用方式................................ 错误！未定义书签。
1.2.1 ASP中的Jscript和VbScript的调用............... 错误！未定义书签。
1.2.2 C#中的调用...................................... 错误！未定义书签。
1.2.3 Javascript的调用............................... 错误！未定义书签。
1.2.4 Java的调用方式................................. 错误！未定义书签。
1企业API接口企业API接口的实现使用了WebService的方式，企业用户通过调用WebService的指定接口函数以达到发送和接收短信的目的；企业接口的服务页面为WebService/EntInterface.asmx，如果WEB服务器地址为：http://61.191.40.242:9090那么访问WebService的地址就为：http://61.191.40.242:9090/WebService/EntInterface.asmx要查看接口的定义的话则在连接地址下面增加“?WSDL”，即：http://61.191.40.242:9090/WebService/EntInterface.asmx?WSDL1.1 接口函数说明企业接口中提供了三个函数，如下：string SendMessage (string strLoginCode, string strPass, string strSpNum,string strRecvNum, string strMsg, int bConfirm, string AtDate) string RecvMessage (string strLoginCode, string strPass)string GetStatus (string strLoginCode, string strPass, string strSendID)SendMessage 函数为发送消息的函数RecvMessage 函数为接收企业用户消息的函数GetStatus 函数为检测发送流水的消息函数1.1.1发送消息函数SendMessage函数定义如下：string SendMessage (string strLoginCode, string strPass, string strSpNum,string strRecvNum, string strMsg, int bConfirm, string AtDate)对于返回的结果XML结构如下:<?xml version="1.0" encoding="GB2312"?><result status="0" message=”发送成功”><serial_id count="2" ><id value=”1005” sp_name=”电信”/><id value=”1006” sp_name=”电信”/></serial_id></result>在每个result节点中:status的值表示当前服务器返回的结果，message表示其描述信息，其含义如下:下面的serial_id节点表示本次发送的任务流水号，count表示本次发送了多少个任务，对于此节点下面的id节点，每个节点都有两个属性:value和sp_name，value表示实际发送的任务ID，sp_name则表示此任务ID发送的号码是哪个运营商的，可选值为如下四个:电信、网通、移动、联通；即如果是群发任务的时候，每一个任务ID下可能会有多个号码，在查询发送结果的时候需要根据任务ID+号码的方式来查询，不同运营商的号码用不同的任务ID+号码才能查询到对应的发送结果。
API接口设计说明书介绍
XXAPI接口设计说明书公司2016 年11 月25日文档管理信息表主题XX api 接口设计说明书版本内容要点字参照文档创办时间创办人最新宣布日期文档改正记录表更正人更正时间更正内容创办目录文档改正记录表 ..........................................................目录 . ..................................................................序言 . ...................................................................编写目的 .....................................................背景 .........................................................定义 .........................................................参照资料 .....................................................综述 . ...................................................................一致的输入输出参数...........................................必定登录才能接见的接口.......................................错误返回码列表...............................................用户接口 . ...............................................................用户注册（ user/signup）......................................用户登录（ user/signin）......................................优惠券接口 ..............................................................我的优惠券（ coupon/mycoupon ） ................................编写目的{ 说明编写这份用户手册的目的，指出预期的读者。
广州首易信息技术有限公司API接口使用手册说明书
广州首易移动业务A P I （W e b S e r v i c e）使用手册广州首易信息技术有限公司2012年1月目录一、引言 (4)1.1 编写目的 (4)1.2 背景说明 (4)1.3 术语定义 (4)二、概述 (5)2.1 接口功能 (5)2.2 接口组成 (5)三、接口介绍 (6)3.1 网络结构 (6)3.2 运行环境 (6)3.3连接方式 (6)3.4 WebService地址 (6)3.5 WSDL描述文件 (7)四、API函数说明 (7)4.1短信部分 (7)4.1.1 Sms_Send函数 (7)4.1.2 Sms_GetRecv函数 (8)4.1.3 Sms_GetReport函数 (9)4.1.4 Sms_GetSign函数 (10)4.1.5 Sms_GetBalance函数 (10)4.2彩信部分 (11)4.2.1 Mms_UpFile函数 (11)4.2.2 Mms_GetFileStatus函数 (12)4.2.3 Mms_Send函数 (13)4.2.4 Mms_GetRecv函数 (14)4.2.5 Mms_GetReport函数 (15)4.3批量任务部分 (16)4.3.1 Task_UpFile函数 (16)4.3.2 Task_DelFile函数 (17)4.3.3 Task_SmsSend函数 (18)4.3.4 Task_GetSmsStatus函数 (19)4.3.5 Task_SmsStop函数 (20)4.3.6 Task_SmsStart函数 (20)4.3.7 Task_MmsSend函数 (21)4.3.8 Task_GetMmsStatus函数 (22)4.3.9 Task_MmsStop函数 (23)4.3.10 Task_MmsStart函数 (24)五、附件 (24)5.1错误代码汇总表 (24)5.2短信/彩信状态码汇总表 (27)5.3批量任务短信/彩信状态码汇总表 (27)一、引言1.1 编写目的广州首易的移动商务平台提供了强大的移动业务接入机制，现支持短信、彩信的全国应用。
vb api函数使用手册
vb api函数使用手册VB API函数使用手册是一个非常广泛的主题，因为Visual Basic（VB）有很多API函数可用于各种任务。
不过，我将提供一个示例来说明如何查找和使用VB API函数。
假设您想使用VB来处理文件，并希望查找一个API函数来获取文件的创建日期。
1. 查找API函数:打开VB的文档或在线资源，查找与文件操作相关的API函数。
在这个例子中，您可能会找到一个名为`GetFileTime`的函数，该函数用于获取文件的创建、访问和修改时间。
2. 使用API函数:根据函数的定义，您可能需要使用它之前设置一些参数，例如文件的路径。
调用函数并处理返回值。
3. 示例代码:以下是一个使用`GetFileTime`函数的示例代码片段：```vbImportsPublic Sub GetFileTimeInfo(ByVal strFileName As String)Dim fTime As FileTimeDim CreationTime As DateTime = New DateTime()Dim AccessTime As DateTime = New DateTime()Dim WriteTime As DateTime = New DateTime()Dim hFile As IntPtr = CreateFile(strFileName, GENERIC_READ, FILE_SHARE_READ, , OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, ) If hFile <> ThenIf GetFileTime(hFile, AddressOf SetFileTime, ) ThenCreationTime = FileTimeToDateTime(fTime)AccessTime = FileTimeToDateTime(fTime)WriteTime = FileTimeToDateTime(fTime)End IfCloseHandle(hFile)End If("Creation Time: " & ())("Access Time: " & ())("Write Time: " & ())End SubPrivate Function SetFileTime(ByRef pft As FileTime) As BooleanReturn True ' Just return true always since we are not using it for anything important.End Function```4. 注意事项:确保您有适当的权限来访问文件。
WebOffice常用API接口在线参考手册
WebOffice常⽤API接⼝在线参考⼿册WebOffice控件是国内领先的在线编辑Office⽂档软件，软件产品从1998年⽴项⾄今已有20多年历史，期间服务了众多⼤中⼩型企业、各级政府机关、科研机构和学校等事业单位。
通过WebOffice软件可以让⽤户⽅便从远程直接打开Word,Excel,Ppt等⽂档编辑后再次保存⾄服务器原位置，实现远程编辑⽂档、远程保存，为⽤户在线办公开创新式、便捷的使⽤体验。
WebOffice⽂档控件(标准版永久授权)原价8000元，现活动优惠价只需7846元12.SaveAs ⽂档另存为SaveAs( strFileName, dwFileFormat);参数：strFileName：⽂件本地路径，如c:\\a.docdwFileFormat: ⽂件格式对于Word,Excel,PPT⽂档dwFileFormat的数值是不同的：Excel: Typeenum XlFileFormat{xlAddIn = 18,xlCSV = 6,xlCSVMac = 22,xlCSVMSDOS = 24,xlCSVWindows = 23,xlDBF2 = 7,xlDBF3 = 8,xlDBF4 = 11,xlDIF = 9,xlExcel2 = 16,xlExcel2FarEast = 27,xlExcel3 = 29,xlExcel4 = 33,xlExcel5 = 39,xlExcel7 = 39,xlExcel9795 = 43,xlExcel4Workbook = 35,xlIntlAddIn = 26,xlIntlMacro = 25,xlWorkbookNormal = -4143,xlSYLK = 2,xlTemplate = 17,xlCurrentPlatformText = -4158,xlTextMac = 19,xlTextMSDOS = 21,xlTextPrinter = 36,xlTextWindows = 20,xlWJ2WD1 = 14,xlWK1 = 5,xlWK1ALL = 31,xlWK1FMT = 30,xlWK3 = 15,xlWK4 = 38,xlWK3FM3 = 32,xlWKS = 4,xlWorks2FarEast = 28,xlWQ1 = 34,xlWJ3 = 40,xlWJ3FJ3 = 41,xlUnicodeText = 42,xlHtml = 44};Word: Typeenum WdSaveFormat{wdFormatDocument = 0,wdFormatTemplate = 1,wdFormatText = 2,wdFormatTextLineBreaks = 3,wdFormatDOSText = 4,wdFormatDOSTextLineBreaks = 5,wdFormatRTF = 6,wdFormatUnicodeText = 7,wdFormatEncodedText = 7,wdFormatHTML = 8};PPT:enum PpSaveAsFileType{ppSaveAsPresentation = 1,ppSaveAsPowerPoint7 = 2,ppSaveAsPowerPoint4 = 3,ppSaveAsPowerPoint3 = 4,ppSaveAsTemplate = 5,ppSaveAsRTF = 6,ppSaveAsShow = 7,ppSaveAsAddIn = 8,ppSaveAsPowerPoint4FarEast = 10,ppSaveAsDefault = 11,ppSaveAsHTML = 12,ppSaveAsHTMLv3 = 13,ppSaveAsHTMLDual = 14,ppSaveAsMetaFile = 15,ppSaveAsGIF = 16,ppSaveAsJPG = 17,ppSaveAsPNG = 18,ppSaveAsBMP = 19};13.GetTempFilePath 创建临时⽂件var strFile = document.getElementById('WebOffice').GetTempFilePath()GetTempFilePath会返回本地电脑⼀个临时⽂件存储地址，使⽤后应⽤DeleteLocalFile删除。
V平台webapi接口格式说明
V平台webapi接⼝格式说明V平台webapi接⼝格式说明银弹⾕V平台部2017/9/22修订⽬录V平台WEBAPI接⼝格式说明 (1)银弹⾕V平台部 (1)1. 概述 (3)1.1构件API的⼀般访问形式 (3)1.2构件API的定义 (4)1.3构件API的版本 (4)1.4HTTP请求格式的⼀般约定 (4)2. 安全控制 (5)2.1⼦系统层次安全控制 (5)2.2业务⽤户层次安全控制 (5)3. 构件API输⼊参数 (6)3.1定义 (6)4. 返回数据格式 (7)4.1HTTP响应头 (7)4.2执⾏结果 (7)5. API⽂档发布 (8)1.概述构件是V平台的功能包装单元，系统的主要业务功能通过构件⾃⾝、以及构件之间的协作完成。
构件内可通过配置⽅式对外提供具体的业务API，构件API通过HTTP调⽤⽅式对外公开。
构件API除了从属于某⼀个构件、有⼀个标识名称以外，构件API还从属于某⼀个命名空间，命名空间⽤于对API进⾏适当的归类，以便于管理和使⽤。
命名空间+ API名称，构成了构件API的唯⼀标识。
1.1构件API的⼀般访问形式构件API访问形式：命名空间/apiCode，类似：http://*****:**/context/webapi/VBASE/WORKFLOW/DEFINITION/CreateWorkflowDe finition●其中，*****:**指应⽤所在的域名及端⼝；●context指应⽤上下⽂；●webapi是固定的api标识；●VBASE/WORKFLOW/DEFINITION指API的命名空间，命名空间可以在开发系统中，定义业务API的时候设定；●CreateWorkflowDefinition指具体的API名称另外：为了兼容之前已经有的vbase所提供的api，兼容⽀持以下的访问格式：形如调⽤vbase的原有的api形式为：构件code/apiCode例如：http://*****:**/webapi/vbase_workflow/API_GetBizProcessInstanceRela1.2构件API的定义1.3构件API的版本⼀般情况下，为了维持构件API的稳定性以及易⽤性，通常API需要做到向下兼容，即：相同API标识（构件名+命名空间+API 名称）下，其输⼊参数和返回值格式是稳定的。
api接口文档模板
接口文档说明
1 接口参考 (1)
1.1 登陆 (1)
1.2 登陆接口 (1)
1 接口参考
1.1登陆
1.2登陆接口
1.2.1.1接口说明
1.2.1.1 请求说明
1.2.1.2 参数特殊说明
比如有签名认证的，toke n的，特殊加密算法说明等比如有签名认证的， token的，特殊加密算法说明等比如有签名认证的，token的，特殊加密算法说明等比如有签名认证的，toke n的，特殊加密算法说明等比如有签名认证的， token的，特殊加密算法说明等比如有签名认证的，token的，特殊加密算法说明等比如有签名认证的，toke n的，特殊加密算法说明等比如有签名认证的， token的，特殊加密算法说明等比如有签名认证的，token的，特殊加密算法说明等比如有签名认证的，token的，特殊加密算法说明等。
121.3 url 说明
此接口是登录接口，用于客户登录使用此接口是登录接口，用于客户登录使用接口是登录接口，用于客户登录使用此接口是登录接口，用于客户登录使用接口是登录接口，用于客户登录使用此接口是登录接口，用于客户登录使用接口是登录接口，用于客户登录使用此接口是登录接口，用于客户登录使用接口是登录接口，用于客户登录使用此接口是登录接口，用于客户登录使用接口是登录接口，用于客户登录使用此接口是登录接口，用于客户登录使用。
121.4 返回说明
121.5 返回示例
{
"code" :200,
"msg":"登录成功",
"data" :{
"username":"测试账号"
}
}。
VISCA接口API描述用户手册说明书
VISCA interface API description User ManualCommand list:cameraCommand list:cameraCommand set Command Command packet Comments-stop8x01040700FFcontinuous zoomtele fixed spped8x01040702FFwide fixed speed8x01040703FFtele controllable speed8x0104072p FF p=speed,min0x0,max0x7wide control speed8x0104073p FF p=speed,min0x0,max0x7 absolute zoom-8x01040702FF pqrs=position0x0000to0x4000optical range0x4001to07AC0digital range-stop8x01040800FFcontinuous focusfar fixed speed8x01040802FFnear fixed speed8x01040803FFfar controllable speed8x0104082p FF p=speed,min0x0,max0x7near controllable speed8x0104083p FF p=speed,min0x0,max0x7 absolute focus-8x0104480p0q0r0s FF pqrs=position,min0x1000,max0xF000 auto focus-8x010438pq FF pq=mode0x10=toggle0x02=on0x03=off set focus near limit-8x0104280000000p FF p=distance0x2=20.00m0x3=10.00m0x4=6.00m0x5=4.20m0x6=3.10m0x7=2.50m0x8=2.00m0x9=1.65m0xA=1.40m0xB=1.20m0xC=0.80m0xD=0.30m0xE=0.11m white balance-8x0104350p FF p=mode0x0=auto0x1=fixed indoor0x2=fixed outdoor0x4=auto outdoor0x5=manual white balance one push trigger8x01041005FF-relative red gain-8x0104030p FF p=mode0x0=reset,set to50%0x2=up,more0x3=down,less absolute red gain-8x010********p0q FF pq=gain,min0x00,max0xFFCommand list:camerarelative blue gain-8x0104040p FF p=mode0x0=reset,set to50%0x2=up,more0x3=down,less absolute blue gain-8x010********p0q FF pq=gain,min0x00,max0xFF auto exposure-8x0104390p FF p=mode0x0=full auto0x3=full manual0xA=shutter priority0xB=iris priority0xD=bright mode relative shutter-8x01040A0p FF p=mode0x0=reset0x2=up,shorter0x3=down,longer absolute shutter-8x01044A00000p0q FF pq=time0x00=1/1s/0x00=1/1s0x01=1/2s/0x01=1/2s0x02=1/3s/0x02=1/4s0x03=1/6s/0x03=1/8s0x04=1/12s/0x04=1/15s0x05=1/25s/0x05=1/30s0x06=1/50s/0x06=1/60s0x07=1/75s/0x07=1/90s0x08=1/100s/0x08=1/100s0x09=1/120s/0x09=1/125s0x0A=1/150s/0x0A=1/180s0x0B=1/215s/0x0B=1/250s0x0C=1/300s/0x0C=1/350s0x0D=1/425s/0x0D=1/500s0x0E=1/600s/0x0E=1/725s0x0F=1/1000s/0x0F=1/1000s0x10=1/1250s/0x10=1/1500s0x11=1/1750s/0x11=1/2000s0x12=1/2500s/0x12=1/3000s0x13=1/3500s/0x13=1/4000s0x14=1/6000s/0x14=1/6000s0x15=1/10000s/0x15=1/10000sCommand list:Pan/TiltCommand list:Pan/TiltCommand set Command Command packet Commentsmove up8x010601pp tt0301FFmove down8x010601pp tt0302FFmove left8x010601pp tt0103FFmove right8x010601pp tt0203FFmove up-left8x010601pp tt0101FFmove down-left8x010601pp tt0102FFmove up-right8x010601pp tt0201FFmove down-right8x010601pp tt0202FF continuous pan tiltstop movement8x010601pp tt0303FF pp=pan speed,min0x01,max0x18 tt=tilt speed,min0x01,max0x17absolute pan tilt move directly to targetposition 8x010602pp tt0g0h0i0j0k0l0m0n FFpp=pan speed,min0x01,max0x18tt=tilt speed,min0x01,max0x17ghij=pan position,min0xDE00(-0x2200),max0x2200klmn=tilt position,min0xFC00(-0x0400),max0x2200relative pan tilt move requesteddistance 8x010603pp tt0g0h0i0j0k0l0m0n FFpp=pan speed,min0x01,max0x18tt=tilt speed,min0x01,max0x17ghij=pan change,min0xBC00(-0x4400),max0x4400klmn=tilt change,min0xEA00(-0x1600),max0x1600goto home move to home position8x010604FF-reset pan tilt resets pan tilt driver8x010605FF-set pan tilt limits-8x010607000p0g0h0i0j0k0l0m0n FF p=corner,down-left0x0,up-right 0x1ghij=pan position,min0xDE00,max 0x2200klmn=tilt position,min0xFC00 (-0x0400),max0x1200Command list:extendedCommand list:extendedCommand set Command Command packet Comments tally control control tally light8x017E010A000p FF p=mode0x2=on0x3=offInquiry list:DeviceInquiry list:DeviceCommand set Command packet Inquiry packet CommentsVersion X090002FF9y50415856pq rs0002FF pqrs=product numberExample:pqrs=5925for AXISV5925Inquiry list:CameraInquiry list:CameraCommand set Command packet Inquiry packet Commentscamera power8x090400FF Fixed to on:y05002FF-auto focus8x090438FF y0500p FF p=mode0x2=on0x3=off white balance8x090435FF y0500p FF p=mode0x0=auto0x1=fixed indoor0x2=fixed outdoor0x4=auto outdoor0x5=manual auto exposure8x090439FF y0500p FF p=mode0x0=auto0x3=full manual0xA=shutter priority0xB=iris priority0xD=bright modeback light compensation 8x090433FF y0500p FF p=mode0x2=on0x3=offspot light mode8x09043A FF Fixed to off:y05003FF-exposure compensation8x09043E FF Fixed to off:y05003FF-zoom position8x090447FF y0500p0q0r0s FF pqrs=position0x0000to0x4000optical range0x4001to0x7AC0digital rangeInquiry list:Pan/tiltInquiry list:Pan/tiltCommand set Command packet Inquiry packet Commentspan tilt position8x090612FF y0500g0h0i0j0k0l0m0n FF ghij=pan position,min0xDE00(-0x2200),max0x2200klmn=tilt position min0xFC00(-0x0400),max0x1200 menu display8x090606FF Fixed to off:y05003FF-User Manual Ver.M1.6 VISCA interface API description Date:March2021©Axis Communications AB,2021Part No.T10162575。
API接口使用手册(简易版)
API接口使用手册(简易版)概述该文档旨在提供使用API接口的简易手册，帮助用户快速了解和使用API接口。
用户可以通过API接口实现与其他系统的数据交互和功能集成。
API接口基本信息- 接口名称: [接口名称]- 接口版本: [接口版本]- 接口地址: [接口地址]接口鉴权在使用API接口之前，用户需要先获得访问凭证，以确保安全性和权限控制。
用户需要向系统管理员申请API访问凭证，并按照指引进行鉴权操作。
接口请求和响应格式请求格式- 请求URL: [请求URL]- 请求头部：- Content-Type: application/json- Authorization: Bearer [访问凭证]- 请求参数：用户根据具体接口需求传递相应的请求参数，格式为JSON。
{"param1": "value1","param2": "value2"}响应格式- 响应状态码：- 200: 请求成功- 400: 请求参数错误- 401: 访问未授权- 500: 服务器错误- 响应数据格式：响应数据以JSON格式返回。
{"code": 200, "message": "请求成功", "data": {"param1": "value1", "param2": "value2"}}接口示例示例1: 获取用户信息- 接口地址: /api/user- 请求方法: GET请求参数无响应示例{"code": 200,"message": "请求成功", "data": { "username": "example",}}示例2: 创建用户- 接口地址: /api/user- 请求方法: POST请求参数{"username": "newuser", "password": "password123" }响应示例{"code": 200, "message": "用户创建成功","data": {"username": "newuser",}}注意事项- 请确保在使用API接口前先进行鉴权操作，以获得访问凭证。
中国移动语音平台通讯接口协议-V1.12003-10-07# 1
以上XML描述表示一个操作过程中包体收发的会话信息。
operate_id="00002"表示操作号。
type="01"表示pdu包是语音平台主动发起，如果type="02"表示pdu包是SP平台主动发起。
bodytype="02"表示pdu包各字段是不定长的，以分隔符分割各字段。
cry_type
5
String
包体加密算法类型，00000代表不加密，其他代表事先约定的加密类型，加密只对包体进行。
key_no
5
String
加密密钥序号，代表事先双方约定的加密密钥的顺序号
体
Field_1
String
根据各个操作的业务需要设定长度和选择使用，每个字段长度不大于128位
…
…
Field_n
包体字段的定义有以下两种方式：
a>包体字段定长(各个字段有长度表示)
<operateoperate_id="00001"type="01">
<sendbodybodytype="01">
<fieldorder="1"name="name1"size="10"/>
<fieldorder="2"name="name2"size="10" />
包体结构如下：
字段1+字段2+字段3 +字段4+…+字段X
b>包体字段不定长(各个字段无长度表示,分隔符由SP自定义)
视频接入服务API参考说明书
视频接入服务API参考文档版本01发布日期2022-07-29版权所有 © 华为技术有限公司 2022。
保留一切权利。
非经本公司书面许可，任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部，并不得以任何形式传播。
商标声明和其他华为商标均为华为技术有限公司的商标。
本文档提及的其他所有商标或注册商标，由各自的所有人拥有。
注意您购买的产品、服务或特性等应受华为公司商业合同和条款的约束，本文档中描述的全部或部分产品、服务或特性可能不在您的购买或使用范围之内。
除非合同另有约定，华为公司对本文档内容不做任何明示或暗示的声明或保证。
由于产品版本升级或其他原因，本文档内容会不定期进行更新。
除非另有约定，本文档仅作为使用指导，本文档中的所有陈述、信息和建议不构成任何明示或暗示的担保。
目录1 使用前必读 (1)1.1 概述 (1)1.2 终端节点 (1)1.3 约束与限制 (2)1.4 基本概念 (2)2 API概览 (4)3 如何调用API (7)3.1 构造请求 (7)3.2 认证鉴权 (10)3.3 返回结果 (12)4 服务开通管理 (14)4.1 开通服务 (14)4.2 获取服务开通信息 (19)5 视频流管理 (25)5.1 创建视频流 (25)5.2 获取视频流列表 (30)5.3 更新视频流 (35)5.4 获取视频流信息 (38)5.5 删除视频流 (43)5.6 更新转储信息 (45)5.7 获取视频流地址 (48)6 设备管理 (51)6.1 创建GB/T28181设备通道 (51)6.2 获取设备列表 (54)6.3 更新GB/T28181设备通道信息 (59)6.4 获取NVR设备通道列表 (61)6.5 删除GB/T28181设备 (64)6.6 更新NVR设备通道列表 (66)6.7 更新GB/T28181设备通道接入策略 (67)7 凭证管理 (72)7.1 创建GB/T28181凭证 (72)7.2 获取GB/T28181凭证列表 (75)7.3 删除GB/T28181凭证 (78)7.4 更新GB/T28181凭证 (79)7.5 创建AK/SK凭证 (81)7.6 获取AK/SK凭证列表 (84)7.7 删除AK/SK凭证 (86)7.8 更新AK/SK凭证 (88)8 设备指标统计 (91)8.1 获取新上线设备列表 (91)8.2 获取新掉线设备列表 (96)8.3 获取长期不在线设备列表 (101)8.4 获取近期掉线的设备列表 (106)8.5 获取在线未推流设备列表 (111)8.6 获取视频包接收率 (116)8.7 获取曾经上线的设备列表 (119)9 obs桶策略管理 (125)9.1 更新桶授权 (125)9.2 获取桶信息列表 (127)10 公共数据结构 (130)11 附录 (132)11.1 状态码 (132)11.2 错误码 (135)11.3 获取项目ID/账号名/AK/SK (138)A 修订记录 (140)1使用前必读概述终端节点约束与限制基本概念1.1 概述欢迎使用视频接入服务（Video Ingestion Service，简称VIS），该服务提供实时视频数据接入功能，包括摄像头视频数据采集、实时数据分发和视频数据转储等能力。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
1.2. 适用范围
本文概述了 VSPP 接口 API（包括服务端与客户端） ，并规定了相关接口函数的语法形 式，提供了相关的应用举例，适用于外部服务提供商利用 VSPP 接口加载业务时参考。
1.3. 参考资料
[1] [2] [3] 《中国移动业务支撑系统业务规范，1.0 版》 （2001 年 4 月） CMCC《 “移动梦网”业务管理办法，1.0 版》 《中国移动语音服务平台接口协议（VSPP） （V1.2 试用版）（2001 年 4 月） 》
VSPP API 客户端接口........................................................................................................... 7
2.2.1 2.2.2 2.2.3 2.2.4 2.2.5 2.2.6
API 接口说明书（VSPP）
北京高阳圣思园信息技术有限公司 2004 年 2 月
API 接口说明书
目
1.
录
.................................................................................................................................................. 介绍.................................................................................................................................................. 3 ..................................................................................................................................................3 1.1. 1.2. 1.3. 1.4. 1.5. 1.6. 目的..........................................................................................................................................3 适用范围..................................................................................................................................3 参考资料......................................ห้องสมุดไป่ตู้...........................................................................................3 缩略语......................................................................................................................................3 术语定义..................................................................................................................................4 版本变更记录..........................................................................................................................4
2.1.1 2.1.2 2.1.3 2.1.4 2.1.5 2.1.6 2.1.7
2.2.
VSPPCommInit.................................................................................................................... 5 VSPPReceiveAccept............................................................................................................. 5 VSPPCheckConnectStatus................................................................................................... 5 VSPPReceiveMessage.......................................................................................................... 6 VSPPSendMessage...............................................................................................................6 VSPPCloseConnect..............................................................................................................6 VSPPReleaseSource............................................................................................................. 6
2.
........................................................................................................................ VSPP API 接口概述........................................................................................................................ 5 ........................................................................................................................5 2.1. VSPP API 服务端接口........................................................................................................... 5
3.
VSPPCommInit.................................................................................................................... 7 VSPPCheckConnectStatus................................................................................................... 7 VSPPSendMessage...............................................................................................................7 VSPPReceiveMessage.......................................................................................................... 8 VSPPCloseConnect..............................................................................................................8 VSPPReleaseSource............................................................................................................. 8
北京高阳圣思园信息技术有限公司
第 2 页 共 10 页
API 接口说明书
1. 介绍
1.1. 目的
中国移动公司统一建设全网的语音服务网络和组建类似梦网的商业模式，承载各个服 务提供商的业务，可以降低 SP 的进入门槛，促进业务的发展。中国移动语音服务平台向各 个服务提供商提供业务加载的平台， 并结合服务提供商提供的业务流程和业务数据为用户提 供语音服务。 为取得业务流程所需的业务数据，语音服务平台需要从各服务提供商取得业务数据， 语音服务平台接口协议（VSPP，Voice Service Platform Protocol）定义了相关客户服务所遵 循的协议。 为了使 SP 能尽快进入业务开发模式，高阳圣思园信息技术有限公司为 SP 提供了 Windows 操作系统下的 VSPP 接口 API。其它操作系统下的 API 根据实际应用情况确定。