Open API

Open API 是 Virbox LM 提供给开发者调用的 API ，它面向的是开发者，而不是最终用户，需要开发者自己通过提供的 API 来完成用户注册，许可发布等操作。

API 概览

术语

普通用户：必须用邮箱或手机号作为登录账号，云平台全局可用，可使用不同开发者发布的许可，此类账号可以在终端自助登录云平台的中间件来使用许可软件；

影子账号：账号由创建该账号的开发者管理，仅用于跟开发者自己的账号系统建立关联，此类账号由开发者应用自己管理登录过程；

llicense ID：产品在深思云平台的产品许可ID，取值范围为[1-(2^32-1)]；

三区数据：为开发者提供三个数据存储区域，可以存储任意数据：

rom：在建产品或模板时可以写进去，在许可使用过程中不能修改，最大65535 byte；

raw：在建产品或模板时可以写进去，在许可使用过程中可以修改，最大65535 byte；

pub：在建产品或模板时可以写进去，在许可使用过程中不能修改，最大65535 byte；

接口概述

请求结构：

服务接口地址为：https://openapi.senseyun.com/v2/sv/{$请求操作}

通信协议：HTTPS。

请求方法：仅支持HTTP POST方法,接口调用时ContentType必须设置成"application/json"。

请求参数：每个接口地址中服务接入地址后边的代表请求的操作，以及每个操作都需要包含的公共请求参数和指定操作所特有的请求参数。

字符编码：请求及返回结果都使用 UTF-8 字符集进行编码。

请求结构：JSON

返回结构：JSON
成功结果：HTTP请求返回2xx, 同时返回 json 中 code 属性值为0.

错误结果：当调用出现异常，HTTP请求返回 4xx 或 5xx，返回结构内容忽略。

如果为业务逻辑方面的错误，HTTP请求仍返回 2xx,但返回json中code属性值为非0值，desc属性值为错误说明。

公共参数：

公共请求参数

需要将所有的公共请求参数放在HTTP header中：