通用的账号连接与配置开发文档.doc

Xweibo v2 0 Xweibo 通用的帐号链接开发文档 Xweibo 2011 年 4 月 Xweibo v2 0 I 目 录 1场景一 你的主站域名与部署场景一 你的主站域名与部署 XWEIBO 的域名根域名相同 的域名根域名相同 1 1 1配置与开发说明 1 1 2如果你的网站是使用的是 PHP 语言 2 2场景二 你的主站域名与部署场景二 你的主站域名与部署 XWEIBO 的域名完全不同 的域名完全不同 3 2 1配置与开发说明 3 2 2如果你的网站是使用的是 PHP 语言 6 2 3账号适配器的扩展性 7 2 4如何扩展签名方式 7 2 5如何扩展加密方式 7 2 6如何启用更多的远程动作 ACTION 8 2 7WAP 登录接口说明 8 Xweibo v2 0 1 1场景一 你的主站域名与部署 Xweibo 的域名根域名相同 场景解释 如下 你的主站部署的域名为 你的 Xweibo 部署的域名为 红色部分即为根域名 它们相同 即符合本场景红色部分即为根域名 它们相同 即符合本场景 1 1配置与开发说明 1 如果你的 Xweibo 中 application adapter account 目录下还没有 xauthCookie account adp php 文件 请复制过去 2 更改 xauthCookie account adp php 中的如下常量 XAUTH SITE NAME你的网站名称 XAUTH SITE LOGIN URL你的网站的登录地址 XAUTH SITE REG URL你的网站的注册地址 XAUTH TK DATA ENCRIPT KEY 通讯密钥 重要 XAUTH CK DOMAIN你的网站根域 重要 如 XAUTH SITE UC ENABLE设置为 false 重要 默认值 XAUTH TK DATA CHARSET你的网站所使用的字符集 默认为 UTF 8 注 其它的配置 请参考源码中的说明 每个方法与常量都有详细的用 途说明 3 更改 user config php 文件中的常量 ACCOUNT ADAPTER 的值为 xauthCookie 4 更改你的网站代码 当用户在你的网站登录的时候写如下两个 xauthTK xauthSG COOKIE 退出时删除它们 xauthTK 包含用户信息的一个特定格式的字符串 默认为 JSON TOKEN 的格式由 XAUTH TK DATA FORMAT 常量决定 JSON 格式示例 Xweibo v2 0 2 uid 1234567 uname myName time 1292575506 QUERY 格式示例 uid 1234567 如 假设 XAUTH TK DATA ENCRIPT KEY 为 myKey 代入以上表达式 COOKIE xauthSG md5 sprint s s COOKIE xauthSG myKey 5 更改你的网站代码 当用户在你的网站退出登录的时候 删除如上两个 COOKIE 6 在 Xweibo 后台中 设置为以下其中一个 仅使用原有站点帐号登录 需绑定帐号 使用新浪帐号与原有站点帐号并存方式登录 7 更改你的网站代码 全局判断 如果 xauthTK 与 xauthSG 都验证通 过 签名正确 如果配置为加密 能正常解密未为验证通过 则自动为 当前用户登录 Xweibo 在用户登录时写下了这两个 COOKIE 注 这个特性和步骤是可选的 你可以不实现 如果你实现了这个特性 用户将可以通过 SINA 账号登录你的网站 1 2如果你的网站是使用的是 PHP 语言 恭喜你 你可以用几分钟就可以完成 Xweibo 与你的网站的账号整合连接 1 按照上面 1 2 3 步 的说明 配置好 xauthCookie account adp php 与 user config php 文件 Xweibo v2 0 3 2 拷贝 xauthCookie account adp php 到你的网站 3 更改你的网站代码 当用户在你的网站验证通过并登录时 include once xauthCookie account adp php xwbAccount new xauthCookie account xwbAccount setLocalToken array uid uid uname user name 4 更改你的网站代码 当用户在你的网站验证通过并登录时 include once xauthCookie account adp php xwbAccount new xauthCookie account xwbAccount setLocalToken null 注 以上代码中 uid 用户在你的网站中的 UID user name 是用户名称 xwbAccount setLocalToken 有写会发送写 COOKIE 的头 要求在此之前 没有缓冲输出 5 在 Xweibo 后台中 设置为以下其中一个 仅使用原有站点帐号登录 需绑定帐号 使用新浪帐号与原有站点帐号并存方式登录 6 Xweibo 清除相关缓存 重启 MC 或者删除 var cache 下的文件 2场景二 你的主站域名与部署 Xweibo 的域名完全不同 场景解释 如下 你的主站部署的域名为 你的 Xweibo 部署的域名为 红色部分即为根域名 它们不相同 即符合本场景红色部分即为根域名 它们不相同 即符合本场景 Xweibo v2 0 4 2 1配置与开发说明 1 如果你的 Xweibo 中 application adapter account 目录下还没有 xauthCookie account adp php 文件 请复制过去 2 更改 xauthCookie account adp php 中的如下常量 XAUTH SITE NAME你的网站名称 XAUTH SITE LOGIN URL你的网站的登录地址 XAUTH SITE REG URL你的网站的注册地址 XAUTH TK DATA ENCRIPT KEY 通讯密钥 重要 XAUTH CK DOMAIN你的 Xweibo 根域 重要 如 可 以为空 XAUTH SITE UC ENABLE设置为 true 重要 XAUTH TK DATA CHARSET你的网站所使用的字符集 默认为 UTF 8 XAUTH SITE UC API URL你的网站 接收 XWEIBO 登录与退出通知的 URL API 注 XAUTH SITE UC ENABLE XAUTH SYNC USER STATUS 都启用时 已绑 定用户在 XWEIBO 通过 SINA 登录后 XWEIBO 将通过 SCRIPT 的方式 给这 个接口 XAUTH SITE UC API URL 发送请求 有三个参数 xauthAction xauthTK xauthSG 这些参数名是可定制的 具体见代 码文件 重要 如果你未开发 XAUTH SITE UC API URL 接口 请关闭 XAUTH SYNC USER STATUS 设置为 false XAUTH XWB ROOT URL你的 Xweibo 地址 HTTP 开头 结尾 如 注 如果 xauthCookie account adp php 只在 xweibo 中使用 未复制 到你的网站使用 这一项 可以不配置 注 其它的配置 请参考源码中的说明 每个方法与常量都有详细的用 途说明 3 更改 user config php 文件中的常量 Xweibo v2 0 5 ACCOUNT ADAPTER 的值为 xauthCookie 4 更改你的网站代码 当用户在你的网站登录的时候输出如下 SCRIPT 标签 并保证它在用户的浏览器中被执行 以上各参数值以上各参数值 标红标红 的说明和计算方法如下的说明和计算方法如下 xauthAction API 动作 目前支持 login logout 两种动作 yourDomain 是你的 Xweibo URL xauthTK 包含用户信息的一个特定格式的字符串 默认为 JSON TOKEN 的格式由 XAUTH TK DATA FORMAT 常量决定 JSON 格式示例 uid 1234567 uname myName time 1292575506 QUERY 格式示例 uid 1234567 如 假设 XAUTH TK DATA ENCRIPT KEY 为 myKey 代入以上表达式 xauthSG md5 sprint s s xauthTK myKey 5 更改你的网站代码 当用户在你的网站退出登录的时候 同样 输出如 上 SCRIPT 标签 并保证它在用户的浏览器中被执行 退出时 xauthAction 为 logout Xweibo v2 0 6 6 已绑定用户通过 SINA 账号登录退出时 XWEIBO 同样会给 XAUTH SITE UC API URL 发送步聚 4 和步聚 5 类似的 SCRIPT 请求 用于 通知你的网站 如果你需要这个特性 你必须开发 XAUTH SITE UC API URL 接口给 XWEIBO 调用 如果你忽略这个特性 你 需要设置 XAUTH SYNC USER STATUS 为 false 7 在 Xweibo 后台中 设置为以下其中一个 仅使用原有站点帐号登录 需绑定帐号 使用新浪帐号与原有站点帐号并存方式登录 2 2如果你的网站是使用的是 PHP 语言 恭喜你 你可以用几分钟就可以完成 Xweibo 与你的网站的账号整合连接 1 按照上面 1 2 3 步 的说明 配置好 xauthCookie account adp php 与 user config php 文件 2 拷贝 xauthCookie account adp php 到你的网站 3 更改你的网站代码 当用户在你的网站验证通过并登录时 include once xauthCookie account adp php echo xwbAccount getSyncScript login array uid uid uname user name xweibo 4 更改你的网站代码 当用户在你的网站验证通过并登录时 include once xauthCookie account adp php echo xwbAccount getSyncScript logout array uid uid uname user name xweibo 注 以上代码中 uid 用户在你的网站中的 UID user name 是用户名称 xwbAccount getSyncScript 返回的是一个 SCRIPT HTML 标签 你需要 输出它们到页面 HTML 页面中 5 在 Xweibo 后台中 Xweibo v2 0 7 设置为以下其中一个 仅使用原有站点帐号登录 需绑定帐号 使用新浪帐号与原有站点帐号并存方式登录 6 Xweibo 清除相关缓存 重启 MC 或者删除 var cache 下的文件 7 参考配置说明中的第 6 步 开发 XAUTH SITE UC API URL 接口给 XWEIBO 调用 通知你的网站谁在登录 XWEIBO 如果你忽略这个特性 你需要设 置 XAUTH SYNC USER STATUS 为 false 2 3账号适配器的扩展性 xauthCookie 拥有很好的可扩展性 2 4如何扩展签名方式 适配器中 所有 tk sign 方法 可用于签名 如 默认的 类中存在 tk sign md5 tk sign crc32 两个方法 所以 XAUTH TK DATA SIGN FUNC 可配置为 md5 或者 crc32 签名方法要求 接收一个字符串参数 返回一个不可逆的 HASH 值 命名为 tk sign 是账号适配器的一个成员方法 可参考适配器中的 tk sign md5 方法 2 5如何扩展加密方式 适配器中 所有 tk encrypt 方法 可用于签名 如 默认的 类中存在 tk encrypt dzauth 两个方法 所以 XAUTH TK DATA ENCRIPTION 可配置为 dzauth XAUTH TK DATA ENCRIPTION 默认为空 即不对 TK 进行加密 签名方法要求 接收两个参数 arg 0 为 加密前的明文 Xweibo v2 0 8 arg 1 为 操作类型 可选值 默认为 encode 加密 decode 解密 加密时使用的公钥为 XAUTH TK DATA ENCRIPT KEY 返回一个可逆的密文串 命名为 tk encrypt 是账号适配器的一个成员方法 可参考适配器中的 tk encrypt dzauth 方法 2 6如何启用更多的远程动作 ACTION 在适配器中增加 remote action 方法 参考 remote action login 方 法 第三方请求 api uc php xauthAction 都会被转发到对应的远程 ACTION 中 2 7WAP 登录接口说明 示范性的 WAP 登录接口参考 waplogin php 文件 说明如下 WAP 登录接口接收两个参数 分别是 account 和 password 表示账号和密码 均通 过 POST 方式提交 接口接收到这两个参数之后 对其合法性进行验证 即通过查询数据库等方式 验 证账号和密码是否合法 如果验证通过 返回一个数字类型的用户 ID 用于标记该 用户的身份 如果验证失败 则返