开发者流程

简介

通过开发者流程,您将会获得您的平台如何处理壹写作的作者注册,登录,发布及更新作品的功能。一旦您的开发API通过审核,每个壹写作的作者都可以在出版模块找到您并添加为自己的出版商向您的平台输出作品。

准备按入

我们并未限制申请者的身份,无论是机构,企业还是独立开发者均可以按照自己的需求选择是否接入本平台。

  • 下载任一平台的壹写作客户端。下载

  • 注册成为 征稿 类型用户。

  • 在 我的账户>认证 中进行 实名认证

  • 在我的账户>认证中选择 申请出版商

  • 填写出版商信息及愿意接受的作品的类型,标准

  • 在 申请出版商 内一有选择项需要您提供 web服务地址。

    • web服务地址后跟上 /book 为作品投递地址

    • web服务地址后跟上/status 为作品状态查询地址

  • 用户接口方式分三类,您可视情况开通至少一种接口

    • 第三方账号绑定:弹出窗口在第三方网站登录或注册,完成回调后回调至壹写作。

    • 自动注册:自动注册用户至第三方网站,完成后直接发表

    • 软件内登录:在软件内通过用户名密码登录

  • 需要弹出第三方登录窗口的您针对《壹写作》的登录网址

  • 接收数据格式为文件的选择文件,接收数据格式为json的选择json数据格式

API开发

壹写作用户将向您的服务器POST如下数据并获得一些反馈。初次注册用户注册成功后您需要返回用户名与密码以利用户下次通过出版商账号进行作品发布,如果您无法通过此种方式返回用户名密码,请将信息发送至用户注册邮箱中以方便用户使用。所有第三方用户账号信息均保存在用户本机中,我们的 隐私与条款 保证了这些数据的安全使用。


1. 账号相关

平台可选择是通过第三方账号绑定或自动注册的方式与壹写作用户连接。第三方账号绑定将由出版商提供一个用于注册或登录的页面,壹写作在软件中弹出窗口供用户注册或登录第三方账号。自动注册则由壹写作直接推送用户信息至第三方账号完成绑定。出版商可自行选择账号边接策略。

1.1第三方账号绑定

出版商提供一个特定的注册或登录页面给壹写作,壹写作用户在软件中打开此页面进行注册或登录,完成后获得相互通讯的token。

  1. 出版商需在设置中提供此链接,在申请出版商时即可提供。

  2. 壹写作用户在注册或登录完成后出版商需跳转至壹写作的回调页 http://appchina.1xiezuo.com/thirdapi/logincallback.php并在参数中提供用户可用于账号登录的 openid与accesstoken

  3. 壹写作在收到该登录信息后将保存至服务器,下次用户可直接在文章发表中附上些身份信息进行验证

  4. 用户使用该参数发表作品时无需再次认证


回调参数,附加在url中


字段 意义 备注
code 是否提交错误 必填 。 1为用户已经绑定 2为新增加绑定3为找不到用户
openid 与您的用户表对应的用户id 必填
accesstoken 您的授权参数 必填
error 无code或为其它时显示错误 选填 。true或false
error_message 错误原因 选填 。尽量30字符以内
appid 壹写作分配给第三方的appid 必填
timestamp 时间戳(php时间) 必填
signture 加密参数 必填,用于验证此请求是否来自壹写作合作方
uid 用户在壹写作的id 必填,由壹写作传递给第三方返回




1.2自动注册或账号登录

在获得用户的许可后,壹写作将一些必选的公共信息(呢称,头像等),可选的邮箱信息推送给出版商,出版商可通过这些信息自动为用户注册新用户。如果平台允许,用户也可以直接通过出版商平台的老账户与壹写作的当前账户绑定。

POSTweb服务地址/user

POST参数

参数 意义 备注
usertype 用户登录类型 必填。auto为新用户注册;third为软件内第三方登录;bind为第三方弹窗登录
username 出版商用户账号 usertype为third时必填
password 出版商用户密码 usertype为third时必填
name 用户名称 u_usertype为auto时必填
nickname 用户笔名 u_usertype为auto时必填
picture 用户头像 u_usertype为auto时必填
description 用户描述 u_usertype为auto时必填
sex 用户性别 u_usertype为auto时必填
province 用户所有省份 选填
city 用户所有城市 选填
age 用户年龄 u_usertype为auto时必填
email
用户邮箱 用户选择对出版商开放邮箱时有效
openid 与您的用户表对应的用户id 已经授权的用户选填
accesstoken 您的授权参数 已经授权的用户选填
client_app 客户端参数 必填 ,固定 everywriter
client_uid 客户端参数 必填,用户在壹写作的id号
client_device 客户端参数 用户使用的客户端设置(如android,ios,windows等)

返回数据。返回数据仅接受json格式。


字段 意义 备注
code 是否提交错误 必填 。3为找不到用户 1为找到用户 2为新注册用户
openid 与您的用户表对应的用户id 必填
accesstoken 您的授权参数 必填
usermessage 重要提醒用户注册登录信息 选填 。尽量30字符以内
bookmessage 重要提醒作品提交信息 选填 。尽量30字符以内
username 用户名称 选填。返回此用户名密码字段后用户下次将使用第三方账号出版作品
password 用户密码 选填。
sendmail 发送邮件 选填。布尔值。标明是否通过邮件发送了注册信息

2.作品相关

在用户身份验证完成后,壹写作将作品的相关信息推送给出版商,出版商可根据作品信息对本地作品进行更新或新建。

POSTweb服务地址/book

POST参数


参数 意义 备注
updated 作品更新日期 必填。时间戳格式
booktype 作品类型 必填。如小说,剧本,电子书等
author 作品作者 必填。可能与作者呢称不同
booktitle 作品名称 必填
bid 作品唯一ID标识号 必填。可以通过此标识符与本地库对接
created 作品创建日期 必填。时间戳格式
updateDes 作者更新描述 必填。最长255字符
openid 作者在出版平台的用户id 必填。通过作者身份认证获得
booksize 作品长度 必填。
summary 作品简介 必有。字数不限
booktag 作品分类 必填。可通过本字段与您的本地库分类对接
bookstyle 作品风格 必填。可通过本字段与您的本地库分类对接
publishtype 作品发布状态 必填。full为全本;sub为连载中;signed为签约第三方
showall 作品内容完整性 必填。-1为全部章节,>0表示节选的章节数量
outlink 全本作品链接 选填。
outname 签约出版商名称 选填。
bookcover 作品封面图地址 选填。
datatype 作品数据类型 必填。包括 json与file
bookfile 作品文件地址 选填。当datatype为file时,必填,文件下载地址
content 作品内容 选填。当datatype为json时,必填,更新的作品内容



返回数据。返回数据仅接受json格式。


字段 意义 备注
error 无code或为其它时显示错误 选填 。true或false
error_message 错误原因 选填 。尽量30字符以内
bookurl
作品发布后的链接 选填 。尽量30字符以内
bookmessage 重要提醒作品提交信息 选填 。尽量30字符以内

在线测试

无论在开发过程还是开发完成后,您都可以通过壹写作来测试您的API的合规性。测试成功后,您即可提交资格审核。

  • 已提交申请成为出版商

  • 通过壹写作新建一些作品

  • 在出版中选择您的出版商作为出版对象

  • 反复测试作品发布是滞符合您的需求

  • 测试功能无误后,请返回 我的账户>实名>出版商资料更新 将状态更新为 接口测试已经完成

资格审核

资格审核必需满足如下要求。一经审核通过,会实时出现在出版商列表中。

  • 实名资料审核合格

  • 出版商资料审核合格

  • 出版商接口测试成功

  • 可阅读的出版商作品展示,包括web展示或App展示

注意事项

  • 如对出版商资料进行了更新,用户在发表文章时需要删除已绑定的该出版商并重新绑定