OkayAPI Docs


API Path: /api/App/Market_Online/Heartbeat

API Description: 定时上报用户在线的情况。使用前请先安装在线统计插件

1
API Traffic
HTTP/HTTPS
Protocol
GET/POST
Method
UTF-8
Charset
JSON
Response

API Debug   


API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
online_typeStringOptaion在线类型,通过此类型参数可以区分不同的业务使用场景。例如:好友在线人数、论坛在线人数、社区在线人数。
online_idStringOptaion用户的唯一ID,用于区分每一个用户的唯一ID。推荐使用小白会员的UUID,也可以使用第三方的会员唯一ID,例如微信公众号的ID、微博ID等。对于游客。如果未提供,小白接口将自动根据客户端的特征(例如IP地址)生成一个对应的唯一ID,并推荐在下一次上报时回传给小白接口,以便进行精确的统计。

API Debug

KEYREQUIREDVALUE
app_key *Required
online_type Option
online_id Option

API Response

KEYTypeDescription
err_codeInt操作码,0表示成功,1表示失败,9表示插件未安装
err_msgString错误提示信息,err_code非0时参考此提示信息
online_idString用户唯一ID,如未提供,小白接口会自动生成并分配,请在下一次请求时回传

HTTP Response Code

HTTP Status CodeDescription
Http Status = 200Success
Http Status = 400Illegal-Params
Http Status = 401Illegal-Token
Http Status = 402IP-Banned
Http Status = 404API-NOT-Exsits
Http Status = 406Illegal-APPKEY
Http Status = 407APPKEY-Expired-Out
Http Status = 408APPKEY-Busy
Http Status = 409Illegal-Sign
Http Status = 413API-Traffic-NOT-Enough
Http Status = 415API-LOCKED
Http Status = 500Internal-Server-Error