开发文档

日期	版本	修订内容摘要
2023-08-18	v2.0.0	更新接口文档

1、概述

2、版权登记接口

2.1 版权出证

2.1.1 接口说明

url	/open/copyright/copyrightCertificate
协议	https
consumes	["form-data"]
请求方式	POST
描述	图片：格式支持 JPG、JPEG、PNG，8M 以内，尺寸大于等于 200200，小于等于 20003000 视频：格式支持 MP4、MOV、AVI、WMV、MPEG，大小 200M 以内音频：格式支持 MP3、WAV、WMA，200M 以内文档：格式支持 PDF、DOCX，大小 200M 以内

2.1.2 请求参数描述

Name	In	Type	required	limit	Description
appId	body	String	是		在 https://www.chuanglan.com/ 获得
appKey	body	String	是		在 https://www.chuanglan.com/ 获得
acquired	body	Int	是		权利获得方式(1-原始/2-继承/3-承受/4-其他)
authType	body	Int	是		对应商品 ID（430010001-贵州版权局 、 430010002- 重 庆 版 权 局 、430010003-北方国家版权交易中心）
authorType	body	Int	是		作者类型(1-个人/2-机构)
authors	body	JSONArray	是		作者列表，详情请参照 authors 参数说明
belongWay	body	Int	是		权利归属方式(1-个人作品/2-合作作品/3-法人作品/4-职务作品/5-委托作 品)
consignee	body	JSONObjec t	否		收件人信息，详情请参照 consignee 参数说明(paperCertificate 是 1，该项必填)
createProperty	body	Int	否		作品性质：1 原创,2 改编,3 翻译,4 汇编,5 注释,6 整理,7 其他(authType 的商品 ID 为 430010001，430010002 时，该项为必填项)
creationDate	body	String	是	YYYY-MM-DD	创作日期
creationPlace	body	String	是	200（字符）	创作地点（国家+城市名，如中国深圳）
creativeProcess	body	String	是	200（字符）	创作过程
creativePurposes	body	String	是	200（字符）	创作目的
extFile	body	String	否		其他材料链接
fileList	body	JSONArray	是		登记文件地址列表，详情请参照 fileList 参数说明
firstDate	body	String	否	YYYY-MM-DD	首次发表日期（publishStatus 是 1，该项必填）
firstPlace	body	String	否	200（字符）	首次发表地点（publishStatus 是 1，该项必填。网站/媒体/app 等，如百度）
letterFile	body	String	否		作品原创承诺书链接
obligeeAddress	body	String	是	64（字符）	权利人地址（具体地址，如深圳市南山区清华信息港 308）
obligeeEmail	body	String	是	200（字符）	权利人邮箱
obligeeName	body	String	是	30（字符）	权利人名称
obligeePhone	body	String	是	11（字符）	权利人电话
obligeeType	body	Int	是		权利人类型(1-个人/2-机构)
paperCertificat e	body	Int	否		是否需要纸质版证书(0-不需要/1-需要)，默认不需要纸质证书;authType 的商品 ID 为 430010003 才有该选项
productPubAn nex	body	String	否		作 品 发 布 佐 证 附 件 ( 格 式 ： jpg/jpeg/png/pdf,大小限制 10M 以内； authType 是 430010001, 且 publishStatus 是 1 时,该项为必填项)
prossessInfo	body	Array	是		权利拥有情况：选项有（多选）：1 全部权利,3 发表权,4 署名权,5 修改权,6 保护作品完整权,7 复制权,8 发行权,9 出租权,10 展览权,11 表演权,12 放映权,13 广播权,14 信息网络传播权,15 摄制权,16 改编权,17 翻译权,18 汇编权,19 其他 备注：authType 的商品 ID 为 30010001 和 430010002 时，不支持选项有:1 全部权利

prossessInfoDescription	body	String	否	200（字符）	权利拥有情况说明
publishStatus	body	Int	是		发表状态：1 已发表,2 未发表
signInfo	body	String	是	64（字符）	权利人署名信息
validCertificate1	body	String	是		权利人个人身份证人像面/企业营业执照
validCertificate2	body	String	是		权利人个人身份证国徽面(obligeeType 是 1，该项必填)
validCertificateNumber	body	String	是	18（字符）	权利人个人身份证/企业统一信用代码
workCategory	body	Int	是		作品类别(单选)：1 文字作品 2 口述 作品 3 音乐作品 4 戏剧作品 5 曲 艺作品 6 舞蹈作品 7 美术作品 8 建筑作品 9 摄影作品 10 模型作品 11 杂技艺术作品 12 类似摄制电影 方法创作的作品 13 其他作品 14 电影作品 15 地图 16 工程设计图 17 录音制品 18 录像制品 19 产品 设计图 20 示意图
workName	body	String	是	30（字符）	作品名称
workType	body	Int	是		作品类型(1-图片/2-视频/3-音频/4-文档)
contactNum	body	String	否	11	联系电话（ authType 的商品 ID 为 430010001，430010002 时，该项为必填项)

Name	In	Type	required	limit	Description
address	body	String	是	64（字符）	作者地址（具体地址，如深圳市南山区清华信息港 308）
email	body	String	是	200（字符）	作者邮箱
name	body	String	是	30（字符）	作者名称

phone	body	String	是	11（字符）	作者电话
pseudonym	body	String	是	64（字符）	作者署名(笔名)
validCertificate1	body	String	是		作者个人身份证人像面/企业营业执照的图片链接
validCertificate2	body	String	否		作者个人身份证国徽面图片链接(authorType 是 1，该项必填)
validCertificateNumber	body	String	是	18（字符）	作者个人身份证/企业统一信用代码

Name	In	Type	required	limit	Description
address	body	string	是	200（字符）	收件人地址（具体地址，如深圳市南山区清华信息港 308）
name	body	string	是	200（字符）	收件人名称
phone	body	string	是	11（字符）	收件人手机号

Name	In	Type	required	limit	Description
hash	body	string	是	66（字符）	源文件 hash(注：SHA-256 算法)
type	body	Int	是		1: 版权文件 2：预览文件（注：版权文件必须存在一个或以上， 且预览文件的类型只能是图片。）
url	body	string	是		源文件链接

2.1.3 响应参数示例

{
  "tradeNo": "1092532538133446656",
  "chargeStatus": 0,
  "message": "success",
  "data": {
  "copyrightId": "695355441395400704",
  "appId": "203c7a38db5e4b91a9e5a03e36d9dc07"
  },
  "code": "20000"
}

2.1.4 响应状态码

状态码	描述
20000 - OK	请求成功

2.1.5 响应参数描述

Name	In	Type	Description
tradeNo	body	string	订单号
chargeStatus	body	Int	收费状态
message	body	string	结果描述
code	body	string	状态码
data	body	json	添加结果
copyrightId	body	string	版权登记 id

2.1.6 Code 参数描述

Name	Description
200000	请求成功
30040001	版权登记服务异常
30040002	参数错误
30040008	账户服务次数或余额不足
30090001	网关异常
30090002	无授权
30090003	授权密钥错误
30090004	授权已过期

2.1.7 Data 参数描述

Name	Type	limit	Description
copyrightId	String		版权登记 id
appId	String		AppID

2.1.8 异步回调示例

{
  "msg": "success",
  "code": 0,
  "data": {
  "appId": "847d8c2e00b1468cbcaf42cbab4c68cb",
  "copyrightId": "609978662267256832",
  "url": "https://www.chuanglan.com/M00/04/C8/CgAEAAPqRJ-xATA847.jpg"
  }
}

2.1.9 异步回调参数描述

Name	In	Type	Description
code	body	Int	请求返回状态码
msg	body	string	返回信息描述
data	body		异步结果数据

2.1.10 异步回调 code 参数描述

Name	Description
0	登记成功
30050001	贵州版权登记失败
30050002	重庆版权登记失败
30050003	北版版权登记失败
30050005	贵州版权登记驳回

2.1.11 异步回调 Data 参数描述

Name	Type	limit	Description
appId	String		AppID
copyrightId	String		版权登记 id
url	String		证书 URL

2.2 查询版权出证结果

2.2.1 接口说明

url	/open/copyright/getRegisterCallBackRecord
协议	https
consumes	["form-data"]
请求方式	Post
描述	查询版权出证结果

2.2.2 请求参数描述

Name	In	Type	required	limit	Description
appId	body	String	是		在 https://www.chuanglan.com/ 获得
appKey	body	String	是		在 https://www.chuanglan.com/ 获得
copyrightId	query	String	是		版权登记 id

2.2.3 响应参数示例

{
  "tradeNo": "1092532538133446656",
  "chargeStatus": 0,
  "message": "success",
  "data": {
  "copyrightId": "695355441395400704",
  "url": "https://www.chuanglan.com/group1/M00/04/C8/CgAEAAPqRJ-xATA847.jpg "
  },
  "code": "20000"
}

2.2.4 响应状态码

状态码	描述
200000 - OK	请求成功

2.2.5 响应参数描述

Name	In	Type	Description
tradeNo	body	string	订单号
chargeStatus	body	Int	收费状态
message	body	string	结果描述
code	body	string	状态码
data	body		查看 Data 参数描述

2.2.6 Code 参数描述

Name	Description
200000	请求成功
30040001	版权登记服务异常
30040002	参数错误
30040006	记录找不到
30050001	贵州版权登记失败
30050002	重庆版权登记失败
30050003	北版版权登记失败
30050004	登记中
30050005	贵州版权登记驳回
30090001	网关异常
30090002	无授权
30090003	授权密钥错误
30090004	授权已过期

2.2.7 Data 参数描述

Name	Type	limit	Description
copyrightId	String		版权登记 id
url	String		证书 URL