TopClientSdk开发手册(Windows).docx

TopClientSdk开发手册(Windows)背景TopClientSdk是top提供给PC机应用的一款SDK，目的是提高客户端应用安全性，保证客户端应用的请求均从客户端发起，从而提高授权的安全等级(2级)接口介绍l 授权接口名：authorize接口介绍：此接口会产生top授权中心访问地址(包括私有协议信息)，通过回调函数返回给调用方，调用方可使用默认浏览器或其它组件访问top授权中心，引导用户授权参数列表：参数名参数类型参数值参数释义appkeychar*437037appkeymix_secretchar*AA8EF0E747AFD6E58C2A5E92B1680B78md5(secret)codechar*2e1047b25601af6363223f85b31c83ae/NULL应用序列号，对于单机应用，传入NULL即可，对于需要部署在多台机器的应用，必须传入与每个用户的序列号，且不能为NULL，不同用户的序列号不能相同callbackLPTOPCallbackFuncvoid auth_callback(int ret, LPBYTE pData, long iDataLen, LPVOID pContext)回调函数pContextLPVOIDNULL上下文信息，透传至回调函数返回值：返回类型返回值结果值返回释义int0成功int101build uuid failed产生uuid错误回调函数：参数名参数类型参数值参数释义retint0同接口返回值pDataLPBYTE结果值地址iDataLenlong12结果值长度pContextLPVOIDNULL上下文信息，由接口透传至回调函数l 刷新接口名：refresh接口介绍：此接口可以刷新授权时长，对于安全等级为2的应用，每3天刷新一次，可以延迟R2时长，返回结果为：参数列表：参数名参数类型参数值参数释义appkeychar*21437037appkeymix_secretchar*AA8EF0E747AFD6E58C2A5E92B1680B78md5(secret)refresh_tokenchar*6301920a84ee7f31c63c94429eb23b85db5b670cbf8243b180726928refresh_tokenredirect_urichar*回调地址codechar*2e1047b25601af6363223f85b31c83ae/NULL应用序列号，对于单机应用，传入NULL即可，对于需要部署在多台机器的应用，必须传入与每个用户的序列号，且不能为NULL，不同用户的序列号不能相同callbackLPTOPCallbackFuncvoid refresh_callback(int ret, LPBYTE pData, long iDataLen, LPVOID pContext)回调函数pContextLPVOIDNULL上下文信息，透传至回调函数返回值：返回类型返回值结果值返回释义int0见接口介绍截图成功int101build uuid failed产生uuid错误int201InternetOpen failed, Errcode=XXXX初始化WinINet方法失败int202InternetConnect failed, Errcode=XXXX网络连接异常int203HttpOpenRequest failed, Errcode=XXXX创建http请求失败int204HttpAddRequestHeaders failed, Errcode=添加http请求头参数失败int205HttpSendRequest failed, Errcode=XXXX发送http请求失败(请求地址错误，超时等，具体原因需要根据Errcode确定)int206HttpQueryInfo failed, Errcode=XXXX获取http返回头信息失败int207HttpQueryInfo code failed, dwCode=XXXXhttp状态码异常(非200或400)int208InternetQueryDataAvailable failedhttp返回数据不可用int209InternetReadFile failed获取http返回数据失败回调函数：参数名参数类型参数值参数释义retint0同接口返回值pDataLPBYTE结果值地址iDataLenlong12结果值长度pContextLPVOIDNULL上下文信息，由接口透传至回调函数l 调用Top接口名：call接口介绍：此接口会调用top，返回接口为：参数列表:参数名参数类型参数值参数释义appkeychar*21437037appkeymix_secretchar*AA8EF0E747AFD6E58C2A5E92B1680B78md5(secret)sessionkeychar*6302a05b01d52494c58a42b334a0570d28a187e41437c92263685215sessionkeyp_nameschar*method, fields参数名p_valueschar*taobao.user.get, user_id,nick参数值param_lenint2参数个数useridchar*180724228用户idcodechar*2e1047b25601af6363223f85b31c83ae/NULL应用序列号，对于单机应用，传入NULL即可，对于需要部署在多台机器的应用，必须传入与每个用户的序列号，且不能为NULL，不同用户的序列号不能相同content_typechar*NULL指定http请求中的content_type，传入NULL即为普通的post请求(Content-Type:application/x-www-form-urlencoded;charset=UTF-8)，如果需要上传文件，则传入Content-Type:multipart/form-data;charset=UTF-8;boundary=12345678callbackLPTOPCallbackFuncvoid top_callback(int ret, LPBYTE pData, long iDataLen, LPVOID pContext)回调函数pContextLPVOIDNULL上下文信息，透传至回调函数返回值：返回类型返回值结果值返回释义int0见接口介绍截图成功int101build uuid failed产生uuid错误int201InternetOpen failed, Errcode=XXXX初始化WinINet方法失败int202InternetConnect failed, Errcode=XXXX网络连接异常int203HttpOpenRequest failed, Errcode=XXXX创建http请求失败int204HttpAddRequestHeaders failed, Errcode=添加http请求头参数失败int205HttpSendRequest failed, Errcode=XXXX发送http请求失败(请求地址错误，超时等，具体原因需要根据Errcode确定)int206HttpQueryInfo failed, Errcode=XXXX获取http返回头信息失败int207HttpQueryInfo code failed, dwCode=XXXXhttp状态码异常(非200或400)int208InternetQueryDataAvailable failedhttp返回数据不可用int209InternetReadFile failed获取http返回数据失败回调函数：参数名参数类型参数值参数释义retint0同接口返回值pDataLPBYTE结果值地址iDataLenlong12结果值长度pContextLPVOIDNULL上下文信息，由接口透传至回调函数Demo使用指导l 准备阶段开发环境最好使用Visual Studio 2010，创建新项目SdkDemo将demo目录下的所有文件和sdk目录下的TopClientSdk.dll复制到第一步新建的工程目录下如果开发环境不是Visual Studio 2010，将sdk目录下的msvcp100d.dll和msvcr100d.dll复制到工程目录或System32目录下，否则可能出现无法找到相应dll文件的错误l 授权接口设置appkey，secret和code，如果应用只部署在单台机器上，code为NULL，如果应用部署在多台机器上，code为与每个用户对应的序列号，且不能为NULL，不同用户的序列号不能相同，然后调用_authorize方法，运行工程l 刷新授权接口从授权页面获取sessionkey和refresh_token设置appkey，secret，refresh_token，redirect_uri和code，如果应用只部署在单台机器上，code为NULL，如果应用部署在多台机器上，code为与每个用户对应的序列号，且不能为NULL，不同用户的序列号不能相同，然后调用_refresh方法，运行工程l 调用Top接口设置appkey，secret，access_token，userid和code，如果应用只部署在单台机器上，code为NULL，如果应用部署在多台机器上，code为与每个用户对应的序列号，且不能为NULL，不同用户的序列号不能相同，然后调用_call方法，运行工程l 调用上传文件接口设置appkey，secret，access_token，userid和code，如果应用只部署在单台机器上，code为NULL，如果应用部署在多台机器上，code为与每个用户对应的序列号，且不能为N