契约锁 API
  1. 小程序插件
契约锁 API
  • 平台简介
    • 平台简介
  • 新手指南
    • 接入流程
    • 名称解释
    • 接入示例
  • API协议
    • API协议
  • API文档
    • 合同管理
      • 合同管理-创建合同草稿
      • 合同管理-用文件添加合同文档
      • 合同管理-多文件添加合同文档
      • 合同管理-用模板添加合同文档
      • 合同管理-发起合同
      • 合同管理-抄送合同
      • 合同管理-修改签署方
      • 合同管理-添加签署方
      • 合同管理-浏览页面
      • 合同管理-合同详情
      • 合同管理-获取合同列表
      • 合同管理-下载合同与附属文件
      • 合同管理-下载合同文档
      • 合同管理-强制结束合同
      • 合同管理-上传强制结束附件
      • 合同管理-合同文档添加水印
      • 合同管理-合同延期
      • 合同管理-获取合同操作记录
      • 合同管理-获取合同与附属文件下载链接
    • 签署服务
      • 签署服务-公章签署
      • 签署服务-签署法人章
      • 签署服务-审批
      • 签署服务-合同催签
      • 签署服务-签署页面
      • 签署服务-预签署页面
      • 签署服务-获取短链接
      • 签署服务-撤回/作废合同
      • 签署服务-自定义文件作废合同
      • 签署服务-自定义模板文件作废合同
      • 签署服务-签署作废合同
      • 签署服务-签署个人签名
    • 组织架构
      • 组织架构-子公司列表
      • 组织架构-发送子公司邀请
      • 组织架构-移除子公司
      • 组织架构-对接方信息
      • 组织架构-公司详情
      • 组织架构-获取企业信息变更链接
      • 组织架构-员工列表
      • 组织架构-添加员工
      • 组织架构-更新员工
      • 组织架构-员工详情
      • 组织架构-管理员工角色
      • 组织架构-移除员工
    • 印章管理
      • 印章管理-印章列表
      • 印章管理-印章图片
      • 印章管理-创建印章
      • 印章管理-印章详情
      • 印章管理-编辑印章
      • 印章管理-创建图片印章
      • 印章管理-管理印章状态
      • 印章管理-删除印章
      • 印章管理-公司印章
    • 模板管理
      • 模板管理-模板列表
      • 模板管理-模板详情
      • 模板管理-模版预览页面
      • 模板管理-创建Word模板
      • 模板管理-编辑模板
      • 模板管理-管理模板状态
      • 模板管理-下载模板
      • 模板管理-删除模板
    • 业务分类
      • 业务分类-业务分类列表
      • 业务分类-业务分类详情
    • 个人认证
      • 个人认证-获取个人认证链接
      • 个人认证-查询个人认证状态
    • 企业认证
      • 企业认证-获取企业认证链接PC
      • 企业认证-获取企业认证链接H5
      • 企业认证-获取企业认证链接-带营业执照PC
      • 企业认证-获取企业认证链接-带营业执照H5
      • 企业认证-查询认证结果
    • 外部客户
      • 外部客户-新增外部客户
    • 授权管理
      • 授权管理-单点登录模块授权页面
      • 授权管理-个人签名授权页面
      • 授权管理-取消个人签名授权
      • 授权管理-查询个人静默签授权记录
    • 辅助工具
      • 辅助工具-文件验签
    • 信息校验
      • 信息校验-个人身份校验
      • 信息校验-企业身份校验
  • 单点登录集成
    • 集成流程说明
    • 单点登录
    • 单点登出
    • CAS验证接口规范
  • JS SDK文档
    • JS SDK简介
    • 集成方式说明
    • 对接方服务端接口说明
  • 公告
    • 关于开发平台控制台的说明
  • 小程序插件
    • 插件简介
    • 插件集成说明
    • 生成合同签署令牌
    • 生成个人认证令牌
    • 生成企业认证令牌
    • 生成企业认证令牌(带营业执照)
    • 插件更新记录
  • 常见问题
    • 认证问题
    • 配置问题
    • 接口问题
    • 其他问题
  1. 小程序插件

生成企业认证令牌

生成企业认证令牌#

请求地址#

/companyauth/miniappexchange

请求方式#

POST

请求格式#

application/json;charset=UTF-8

请求参数#

参数名称类型必须描述
companyNameString是待认证公司名称
applicantUser是认证提交人,企业认证通过后,认证提交人会自动成为该企业的系统管理员
registerNoString否待认证公司注册号
legalPersonString否待认证公司法人姓名
callbackUrlString否认证回调地址
closeButtonBoolean否是否显示关闭按钮,默认为true
modifyFieldsString否可修改项参数,支持传入字段:corpName(待认证公司名称)、registerNo(待认证公司注册号)、legalPerson(待认证公司法人姓名),传入的字段,用户在企业认证页面可支持修改,多个字段用逗号隔开(例:corpName,registerNo)
User(提交人信息,企业认证通过后,提交人对应的账号会自动成为该公司的管理员) :
名称类型必须描述
nameString否申请者姓名
contactString是联系方式
contactTypeString是联系方式类型:MOBILE、EMAIL

返回参数#

名称类型描述
codeInteger响应码
messageString响应消息
resultResult认证令牌信息
Result(认证令牌):
名称类型描述
ticketString令牌内容

响应码#

(全局响应码请查看文档末“全局响应码”):
响应码描述
1605COMPANY ALREADY AUTHED,该公司已完成认证

请求示例#

Http示例
POST /companyauth/miniappexchange HTTP/1.1
Host: [host]
x-qys-open-timestamp: [替换为请求头生成的Timestamp]
x-qys-open-signature: [替换为请求头生成的Signature]
x-qys-open-accesstoken: [替换为请求头生成的Token]
Content-Type: application/json
{
    "companyName":"上海契约锁公司",
    "applicant":{
        "name":"张三",
        "contact":"12312378900",
        "contactType":"MOBILE"
    },
    "callbackUrl":"http://www.qiyuesuo.com"
}
Java示例
// 初始化sdkClient
String serverUrl = "https://openapi.qiyuesuo.cn";
String accessKey = "替换为您申请的开放平台App Token";
String accessSecret = "替换为您申请的开放平台App Secret";
SdkClient sdkClient = new SdkClient(serverUrl, accessKey, accessSecret);
User applicant = new User("张三", "12312378900", "MOBILE");
CompanyAuthMiniappTicketRequest request = new CompanyAuthMiniappTicketRequest("上海契约锁公司", new User("12312378900", "MOBILE"));
String response = null;
try {
    response = sdkClient.service(request);
} catch (Exception e) {
    throw new BaseSdkException("调用接口错误,错误原因:" + e.getMessage());
}
SdkResponse<MiniappTicketResult> result = JSONUtils.toQysResponse(response, MiniappTicketResult.class);
if (!result.getCode().equals(0)) {
    throw new BaseSdkException("获取企业认证Ticket失败,失败原因:" + result.getCode() + "," + result.getMessage());
}
logger.info("获取企业认证Ticket成功,Ticket:" + result.getResult().getTicket());
C#示例
// 初始化sdkClient
string serverUrl = "https://openapi.qiyuesuo.cn";
string accessKey = "替换为您申请的开放平台App Token";
string accessSecret = "替换为您申请的开放平台App Secret";
SDKClient client = new SDKClient(accessKey, accessSecret, serverUrl);
CompanyAuthMiniappTicketRequest request = new CompanyAuthMiniappTicketRequest("上海契约锁公司",new User("12312378900", "MOBILE"));
string response = null;
try
{
    response = client.Service(request);
}
catch (Exception e)
{
    throw new Exception("访问接口失败,失败原因:" + e.Message);
}
SdkResponse<MiniappTicketResult> responseObject = HttpJsonConvert.DeserializeResponse<MiniappTicketResult>(response);
if (!responseObject.Code.Equals(0))
{
    Console.WriteLine("获取企业认证Ticket失败,失败原因:" + responseObject.Code + "," + responseObject.Message);
}
else
{
    Console.WriteLine("获取企业认证Ticket成功,ticket:" + responseObject.Result.Ticket);
}
PHP示例
// 初始化$sdkClient
class Util {
    const     url = "https://openapi.qiyuesuo.cn";
    const     accessKey = "替换为您申请的开放平台App Token";
    const     accessSecret = "替换为您申请的开放平台App Secret";
}
$sdkClient = Util::getSDk();
$companyName = '企业认证链接';
// 认证提交人信息
$user = new User();
$user->setName('胡*坤');
$user->setContact('151****6497');
$user->setContactType('MOBILE');
$applicant = $user;
$baseRequest = new CompanyAuthMiniappTicketRequest($companyName, $applicant);
$baseRequest->setRegisterNo('1001001001');
$baseRequest->setLegalPerson('胡*坤');
$baseRequest->setCallbackUrl('http://www.baidu.com');
$result = $sdkClient->service($baseRequest);
print_r($result);
Python示例
# 初始化SdkClient
url = "https://openapi.qiyuesuo.cn"
accessToken = '替换为您申请的开放平台App Token'
accessSecret = '替换为您申请的开放平台App Secret'
sdkClient = SdkClient(url, accessToken, accessSecret)
request = CompanyAuthMiniappTicketRequest()
request.set_companyName("HZK测试企业-111")
applicant = User("HZK", "151****6497", "MOBILE")
request.set_applicant(applicant)
auth_h5_page_response = sdkClient.request(request)
print(auth_h5_page_response)
上一页
生成个人认证令牌
下一页
生成企业认证令牌(带营业执照)
Built with