帮我吧文档:客户端sdk手册:初始化接口

初始化接口

在调用其他非配置以及查询接口之前,需要先调用一次初始化接口,帮我吧在该调用中会执行诸如系统登陆等初始化的操作,该接口有两种调用形式:

1. 代理商的账号和SDK秘钥进行初始化:
此时,帮我吧SDK会随机生成一个该代理商名下的客服账号登录帮我吧,此用法适用于那些不使用帮我吧客服账号,只把帮我吧作为一个远程或者聊天工具使用的情形。具体如下:
请求地址:

http://127.0.0.1:xxxx/apiSystemInit?AgentName={AgentName}&AgentSDKPassword={AgentSDKPassword}&SessionKey={SessionKey}

请求方式: GET
参数说明:

参数 是否必须 说明
AgentName 代理商在帮我吧平台的账号
AgentSDKPassword 代理商的SDK接口秘钥,该秘钥为系统自动生成,可以用代理商账号登录帮我吧后台后查看
SessionKey 通过认证接口获取的会话密钥,如果没有Bangwo8APIServer.conf或者Bangwo8APIServer.conf中ServerSecureKey为空,则表明访问无需秘钥保护,此时不需要此字段

帮我吧SDK秘钥AgentSDKPassword请用您帮我吧管理员账号访问http://www.bangwo8.com/,然后在“参数设置=⇒开发者专区=⇒开发者特权:SDK集成”查看,具体如下图:

2. 使用客服账号和客服密码进行初始化:
此时,帮我吧SDK会使用给定的客服账号登录帮我吧,此用法适用于那些使用帮我吧客服账号的情形。
请求地址:

http://127.0.0.1:xxxx/apiSystemInit?SupportAccount={SupportAccount}&SupportPassword={SupportPassword}&SessionKey={SessionKey}

请求方式: GET
参数说明:

参数 是否必须 说明
SupportAccount 一个合法的帮我吧客服账号
SupportPassword 给定客服账号的帮我吧密码
SessionKey 通过认证接口获取的会话密钥,如果没有Bangwo8APIServer.conf或者Bangwo8APIServer.conf中ServerSecureKey为空,则表明访问无需秘钥保护,此时不需要此字段

返回值说明:
正常情况下,本接口会返回下述JSON数据包给开发者:

{
     "errorcode" : 0,
     "message" : "success",
}
JSON字段 说明
errorcode 应答结果码:
0: 成功
3: 提供的SessionKey非法
4: 启动被控端模块失败
4: 启动主控端模块失败
message 出错消息,可以用于获取进一步的出错原因(该字段在所有应答消息中都有)

页面工具