请求开通企业 - 集简云开发平台接口文档

嵌入方通过此接口同步用户到集简云，如果用户已经同步过了则会自动更新信息（以企业ID，用户ID作为唯一识别ID，更新企业名称、用户名称），同步过来的企业与企业下的成员，可以在集简云开放平台的 “企业管理”下查看

企业下的成员信息，企业下至少包含一个成员，如果您的用户体系没有企业/团队维度，则企业ID，用户ID使用一样的参数即可。

请求参数

Body 参数application/json

company_info

object

企业客户信息

必需

company_identification

string

必需

企业客户唯一标识，例如企业ID或者团队ID

company_name

string

企业客户名称

必需

company_users

array [object {3}]

必需

企业下的成员信息，企业下至少包含一个成员，如果您的用户体系没有企业/团队维度，则企业ID，用户ID使用一样的参数即可

isAdmin

integer

可选

是否为管理员，1管理员，否则非管理员。多个管理员默认第一个生效。

user_name

string

用户名

可选

user_identify

string

用户唯一标识

必需

corp_id

string

必需

嵌入方唯一标识(corp_id)

plan_id

string

必需

开通的企业版本，默认为基础版

corp_token

string

必需

嵌入方访问凭证（参考《获取企业访问凭证》接口：https://apifox.com/apidoc/docs-site/1422646/api-51707802

timestamp

integer

必需

当前时间戳(timestamp)（秒）

sign

string

必需

签名。请求参数（除sign, secret以外）按照ASCII码表的顺序排序（升序），生成加排序串（如key1=value1&key2=value2），然后secret拼接（secretkey1=value1&key2=value2）。最后对加密字符串进行MD5。如果传值为空串加密的时候不需要包含此key。如果value为对象或者数组类型，则应该先对value进行序列化，得到json格式字符串（紧凑格式，去掉':' ','前后空格），然后在进行拼接处理。

cost_info

object

扣费方式

可选

不传时使用默认参数

balance_from

string

余额扣减方式

可选

默认值为: sub_account
main_account: 从主账号中扣除
sub_account: 从当前被创建的子账号中扣除

execute_from

string

执行量扣减方式

可选

默认值为: sub_account
main_account: 从主账号中扣除
sub_account: 从当前被创建的子账号中扣除

示例

{
    "corp_id": "",
    "corp_token": "",
    "timestamp": 1652775685,
    "company_info": {
        "company_identification": "sdk",
        "company_name": "SDK集简云1"
    },
    "company_users": [
        {
            "email": "yuanwentao1@email.jijyun.cn",
            "isAdmin": 1,
            "mobile": "18511835058",
            "user_name": "SDK"
        }
    ],
    "sign": ""
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

integer

状态码

必需

data

object

必需

company_id

string

集简云企业ID

必需

corp_name

string

集简云企业名称

必需

string

管理员邮箱

必需

mobile

string

管理员手机号

必需

uname

string

管理员名称

必需

userid

string

管理员ID

必需

msg

string

状态说明

必需

示例

{
    "code": 0,
    "data": {
        "company_id": "oy6298",
        "corp_name": "SDK集简云1",
        "email": "",
        "mobile": "18511835058",
        "uname": "袁文涛",
        "userid": "ms1972rn"
    },
    "msg": "成功"
}