平台接口

创建企业

接口描述：用于生成内容中台与平台对应的企业组织
接口地址：/api/v1/base/corp/create
方法类型：POST

接口入参：

参数名	是否必须	参数类型	参数说明
appId	是	Long	平台ID
name	是	String	企业名称
openId	是	String	企业在平台侧的唯一ID
timestamp	是	Long	当前 UNIX 时间戳，可记录发起 API 请求的时间。单位：毫秒，5分钟内有效，例如1529223702000
signature	是	String	请求签名（根据签名算法计算得出）
signatureMethod	否	String	默认为SHA256，当前只支持一种算法（未来会支持国密算法）
accountType	否	int	1-正式账号 2-试用账号（不传该参数或者传1 都是创建的正式账号；传2 并且平台配置了试用期天数才会创建试用账号）
clearingType	否	int	1先结算，2后结算(默认为后结算）

接口出参

corpId 是 String 企业唯一标识

secretId 是 String 企业密钥ID

secretKey 是 String 企业密钥Key

注：该接口返回的企业授权凭证信息和企业的对应关系需要平台保存，后续调用企业级接口需要使用。

示例

{
"success": true,
"code": "200",
"msg": null,
"obj": null,
"map": {
  "corpId": "XXXXXXXXX",
  "secretKey": "TIFeOxxxxxxxxxxxxxxxij8wJVkJ7x",
  "secretId": "10xxx5O"
},
"list": null
}

企业密钥（授权凭证）查询

接口描述：当密钥（授权凭证）丢失时可用该接口来获取
接口地址：/api/v1/base/secret/detail
方法类型：GET

接口入参：

参数名	是否必须	参数类型	参数说明
appId	是	Long	平台ID
openId	是	String	企业在平台侧的唯一ID
timestamp	是	Long	当前 UNIX 时间戳，可记录发起 API 请求的时间。单位：毫秒 5分钟内有效，例如1529223702
signature	是	String	请求签名（根据签名算法计算得出）
signatureMethod	否	String	默认为SHA256，当前只支持一种算法（未来会支持国密算法）

接口出参

名称类型说明

corpId String 企业ID

secretId String 企业密钥ID

secretKey String 企业密钥Key

示例

{
"success": true,
"code": "200",
"msg": null,
"obj": null,
"map": {
 "corpId": "XXXXXXXXX",
  "secretKey": "TIFeOxxxxxxxxxxxxxxxij8wJVkJ7x",
  "secretId": "10xxx5O"
},
"list": null
}

企业列表查询

接口描述：通过接口查询平台下所有的企业
接口地址：/api/v1/base/product/corpList
方法类型：GET

接口入参：

参数名	是否必须	参数类型	参数说明
appId	是	Long	平台ID
openId	否	String	企业在平台侧的唯一ID
name	否	String	企业名称
accountType	否	String	账号类型,0:全部，1：正式，2：试用
status	否	String	企业状态，-6：全部，0停用，1正常，2关闭，3已过期
timestamp	是	Long	当前 UNIX 时间戳，可记录发起 API 请求的时间。单位：毫秒 5分钟内有效，例如1529223702
signature	是	String	请求签名（根据签名算法计算得出）
signatureMethod	否	String	默认为SHA256，当前只支持一种算法（未来会支持国密算法）
pageNo	否	int	第几页，默认去1，不参与签名
pageSize	否	int	每页大小，默认10，不参与签名

接口出参

名称	类型	说明
id	String	企业ID，易企秀内部id
openId	String	企业openId
name	String	企业名称
staffCount	int	员工账号个数
creationCount	int	企业作品数量
pvCount	int	企业消耗流量
pvTotal	int	企业总流量
pvLimit	int	pv限制值
pvAvailable	int	可用pv数量
createTime	int	开通时间
expireTime	int	到期时间
smsCount	int	短信消耗数量
status	int	企业状态，0停用，1正常，2关闭，3已过期
accountType	int	账号状态，1-正式账号 2-试用账号

示例

{
  "success": true,
  "code": "200",
  "msg": null,
  "obj": null,
  "map": {
      "pageNo": 1,
      "count": 1,
      "pageSize": 14,
      "end": true
  },
  "list": [
      {
          "id": "df669bcadf06475e8fc487740f8f1cea",
          "openId": "3",
          "name": "接口创建的企业",
          "staffCount": 4,
          "creationCount": 78,
          "pvCount": 40,
          "pvTotal": 0,
          "pvLimit": "-",
          "pvAvailable": "873",
          "pvDesc": "40PV",
          "createTime": "2022-10-24 14:05:37",
          "expireTime": "2033-10-24 14:05:37",
          "status": 1,
          "smsCount": 0,
          "accountType": 1
      }
  ],
  "details": null
}

查询子企业剩余pv

接口描述：查询平台下创建企业的剩余pv 仅限先结算型企业
接口地址：/api/v1/base/product/corp/pv/remaining
方法类型：GET

接口入参：

参数名	是否必须	参数类型	参数说明
appId	是	Long	平台ID
openId	是	String	企业在平台侧的唯一ID
timestamp	是	Long	当前 UNIX 时间戳，可记录发起 API 请求的时间。单位：毫秒 5分钟内有效，例如1529223702
signature	是	String	请求签名（根据签名算法计算得出）
signatureMethod	否	String	默认为SHA256，当前只支持一种算法（未来会支持国密算法）

接口出参

名称类型说明

success bool true代表成功

code String 200代表成功

示例

{
  "success": true,
  "code": "200",
  "msg": null,
  "obj": 10000,
  "map": null,
  "list": null,
  "details": null
}

企业添加pv

接口描述：平台为平台下创建的企业增加pv流量 仅限先结算型企业
接口地址：/api/v1/base/product/corp/pv/add
方法类型：POST

接口入参：

参数名	是否必须	参数类型	参数说明
appId	是	Long	平台ID
openId	是	String	企业在平台侧的唯一ID
timestamp	是	Long	当前 UNIX 时间戳，可记录发起 API 请求的时间。单位：毫秒 5分钟内有效，例如1529223702
signature	是	String	请求签名（根据签名算法计算得出）
signatureMethod	否	String	默认为SHA256，当前只支持一种算法（未来会支持国密算法）
pvCount	是	int	要添加的pv值,注：不参与签名

接口出参

名称类型说明

success bool true代表成功

code String 200代表成功

示例

{
"success": true,
"code": "200",
"msg": null,
"obj": null,
"map":null,
"list": null
}

停用企业

接口描述：平台停用子企业
接口地址：/api/v1/base/product/corp/disable
方法类型：POST

接口入参：

参数名	是否必须	参数类型	参数说明
appId	是	Long	平台ID
openId	是	String	企业在平台侧的唯一ID
timestamp	是	Long	当前 UNIX 时间戳，可记录发起 API 请求的时间。单位：毫秒 5分钟内有效，例如1529223702
signature	是	String	请求签名（根据签名算法计算得出）
signatureMethod	否	String	默认为SHA256，当前只支持一种算法（未来会支持国密算法）

签名字段：appId、openId、timestamp、secretKey
接口出参

名称类型说明

success bool true代表成功

code String 200代表成功

示例

{
"success": true,
"code": "200",
"msg": null,
"obj": null,
"map":null,
"list": null
}

启用企业

接口描述：平台启用子企业
接口地址：/api/v1/base/product/corp/enable
方法类型：POST

接口入参：

参数名	是否必须	参数类型	参数说明
appId	是	Long	平台ID
openId	是	String	企业在平台侧的唯一ID
timestamp	是	Long	当前 UNIX 时间戳，可记录发起 API 请求的时间。单位：毫秒 5分钟内有效，例如1529223702
signature	是	String	请求签名（根据签名算法计算得出）
signatureMethod	否	String	默认为SHA256，当前只支持一种算法（未来会支持国密算法）

签名字段：appId、openId、timestamp、secretKey
接口出参

名称类型说明

success bool true代表成功

code String 200代表成功

示例

{
"success": true,
"code": "200",
"msg": null,
"obj": null,
"map":null,
"list": null
}

更改企业有效期

接口描述：平台更改子企业有效期
接口地址：/api/v1/base/product/corp/expire
方法类型：POST

接口入参：

参数名	是否必须	参数类型	参数说明
appId	是	Long	平台ID
openId	是	String	企业在平台侧的唯一ID
timestamp	是	Long	当前 UNIX 时间戳，可记录发起 API 请求的时间。单位：毫秒 5分钟内有效，例如1529223702
signature	是	String	请求签名（根据签名算法计算得出）
signatureMethod	否	String	默认为SHA256，当前只支持一种算法（未来会支持国密算法）
expires	是	String	过期时间，如：2024-12-31

签名字段：appId、openId、timestamp、secretKey、expires
接口出参

名称类型说明

success bool true代表成功

code String 200代表成功

示例

{
"success": true,
"code": "200",
"msg": null,
"obj": null,
"map":null,
"list": null
}

更改子企业员工数

接口描述：平台更改子企业有效期
接口地址：/api/v1/base/product/corp/staffCount
方法类型：POST

接口入参：

参数名	是否必须	参数类型	参数说明
appId	是	Long	平台ID
openId	是	String	企业在平台侧的唯一ID
timestamp	是	Long	当前 UNIX 时间戳，可记录发起 API 请求的时间。单位：毫秒 5分钟内有效，例如1529223702
signature	是	String	请求签名（根据签名算法计算得出）
signatureMethod	否	String	默认为SHA256，当前只支持一种算法（未来会支持国密算法）
count	是	int	可用员工数

签名字段：appId、openId、timestamp、secretKey、count
接口出参

名称类型说明

success bool true代表成功

code String 200代表成功
示例
```
{
"success": true,
"code": "200",
"msg": null,
"obj": null,
"map":null,
"list": null
}
```
参数签名算法
业务参数为appId=38774YX&openId=123&corpName=易企秀&appKey=123456&timestamp=1620626322562
注：
1、appKey是平台对应的密钥，必须参与签名
2、signatureMethod如果参与签名，需要在接口中增加signatureMethod参数
3、参与生成的signature的参数必须包含请求的所有业务参数(pvCount参数除外)，详见示例与示例代码

java语言签名示例代码：

Long timestamp = System.currentTimeMillis();
List<String> paramList = Arrays.asList(appId,openId,corpName,appKey,timestamp.toString());
Collections.sort(paramList);
String signatureStr = StringUtils.arrayToDelimitedString(paramList.toArray(), "");
String signature = getSHA256Str(signatureStr);

PHP语言签名示例代码：

// 示例数组
$array = array(appId, openId, corpName, appKey, timestamp);
// 对数组进行排序
usort($arr, 'strcoll');

corpId	是	String	企业唯一标识
secretId	是	String	企业密钥ID
secretKey	是	String	企业密钥Key

名称	类型	说明
corpId	String	企业ID
secretId	String	企业密钥ID
secretKey	String	企业密钥Key

名称	类型	说明
success	bool	true代表成功
code	String	200代表成功

名称	类型	说明
success	bool	true代表成功
code	String	200代表成功

名称	类型	说明
success	bool	true代表成功
code	String	200代表成功

名称	类型	说明
success	bool	true代表成功
code	String	200代表成功

平台接口

创建企业

企业密钥（授权凭证）查询

企业列表查询

查询子企业剩余pv

企业添加pv

停用企业

启用企业

更改企业有效期

更改子企业员工数

参数签名算法