HTTP/HTTPS
请求协议
APIUSB / 平台接口 / 获取签到列表
获取签到列表
接口地址:https://api.apiusb.com/api/platform?s=Platform.SignIn.GetList
接口描述: 根据活动名称,获取签到列表,同一用户不可在同一活动中重复签到,支持分页排序。
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
sign_in_activity | 字符串 | 必须 | - | 签到活动名称 | |
page | 整型 | 可选 | 1 | 页码 | |
prepage | 整型 | 可选 | 10 | 每页显示条数 |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
data.items | 数组 | 签到列表 |
data.items[].id | 整型 | 签到的ID号 |
data.items[].sign_in_nickname | 字符串 | 签到活动昵称 |
data.items[].sign_in_activity | 字符串 | 签到活动名称 |
data.items[].sign_in_place | 字符串 | 签到地址 |
data.items[].sign_in_time | 字符串 | 签到时间 |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
sign_in_activity | 必须 | |
page | 可选 | |
prepage | 可选 |
客户端请求示例
{
"ret": 408,
"data": {},
"msg": "非法请求:当前账号不是开发者账号",
"debug": {
"stack": [
"[#1 - 0ms - PHALAPI_INIT]D:\\wamp64\\www\\api\\public\\api\\platform.php(51)",
"[#2 - 0.5ms - PHALAPI_RESPONSE]D:\\wamp64\\www\\api\\vendor\\phalapi\\kernal\\src\\PhalApi.php(46)",
"[#3 - 2.3ms - PHALAPI_FINISH]D:\\wamp64\\www\\api\\vendor\\phalapi\\kernal\\src\\PhalApi.php(74)"
],
"sqls": [],
"version": "2.15.0"
}
}
curl https://api.apiusb.com/api/platform?s=Platform.SignIn.GetList&sign_in_activity=第一次签到&page=1&prepage=10
{
"ret": 408,
"data": {},
"msg": "非法请求:当前账号不是开发者账号",
"debug": {
"stack": [
"[#1 - 0ms - PHALAPI_INIT]D:\\wamp64\\www\\api\\public\\api\\platform.php(51)",
"[#2 - 0.5ms - PHALAPI_RESPONSE]D:\\wamp64\\www\\api\\vendor\\phalapi\\kernal\\src\\PhalApi.php(46)",
"[#3 - 2.3ms - PHALAPI_FINISH]D:\\wamp64\\www\\api\\vendor\\phalapi\\kernal\\src\\PhalApi.php(74)"
],
"sqls": [],
"version": "2.15.0"
}
}
$.ajax({
url: "https://api.apiusb.com/api/platform",
data: {s: "Platform.SignIn.GetList", sign_in_activity:"第一次签到",page: "1",prepage: "10"},
dataType: 'json',
success: function (response, status, xhr) {
console.log(response);
}
});
<?php
require_once dirname(__FILE__) . '/PhalApiClient.php';
$client = PhalApiClient::create()
->withHost('https://api.apiusb.com/api/platform');$rs = $client->reset()
->withService('Platform.SignIn.GetList')
->withparams("sign_in_activity", "第一次签到")
->withparams("page", "1")
->withparams("prepage", "10")
->withTimeout(3000)
->request();
// ret状态码,200表示成功
var_dump($rs->getRet());
// 业务数据
var_dump($rs->getData());
// 提示信息
var_dump($rs->getMsg());
#-*- coding:utf-8 -*-
import PhalApiClient
result = PhalApiClient.PhalApiClient('https://api.apiusb.com/api/platform', 'Platform.SignIn.GetListx', {"sign_in_activity":"第一次签到","page":"1","prepage":"10"}, 3)
//FullscreenActivity.java
import net.phalapi.sdk.*; /**
* 网络操作相关的子线程
*/
Runnable networkTask = new Runnable() {
@Override
public void run() {
// TODO
// 在这里进行 http request.网络请求相关操作
PhalApiClient client = PhalApiClient.create()
.withHost("https://api.apiusb.com/api/platform");
PhalApiClientResponse response = client
.withService("Platform.SignIn.GetList")
.withparams("sign_in_activity", "第一次签到")
.withparams("page", "1")
.withparams("prepage", "10")
.withTimeout(3000)
.request();
String content = "";
content += "ret=" + response.getRet() + "\n";
if (response.getRet() == 200) {
try {
JSONObject data = new JSONObject(response.getData());
content += "data.title=" + data.getString("title") + "\n";
content += "data.content=" + data.getString("content") + "\n";
content += "data.version=" + data.getString("version") + "\n";
} catch (JSONException ex) {
}
}
content += "msg=" + response.getMsg() + "\n";
Log.v("[PhalApiClientResponse]", content);
Message msg = new Message();
Bundle data = new Bundle();
data.putString("value", content);
msg.setData(data);
handler.sendMessage(msg);
}
};
PhalApiClientResponse response = PhalApiClient.create()
.withHost("https://api.apiusb.com/api/platform")
.withService("Platform.SignIn.GetList")
.withparamsList("sign_in_activity", "第一次签到")
.withparamsList("page", "1")
.withparamsList("prepage", "10")
.withTimeout(3000)
.request();
Log.v("response ret", response.ret + "");
Log.v("response data", response.data);
Log.v("response msg", response.msg);
#import "AFNPhalApiClient.h"// POST
NSDictionary *params = @{@"sign_in_activity":@"第一次签到",@"page":@"1",@"prepage":@"10"};
// Call AFNPhalApiClient
[[[[[AFNPhalApiClient sharedClient] withHost:@"https://api.apiusb.com/api/platform"] withService:@"Platform.SignIn.GetList"] withParams:params] requestWithFormDataBlock:^(id formData) {
//
[formData appendPartWithFileData:UIImageJPEGRepresentation([UIImage imageNamed:@"head.JPG"], 1) name:@"file" fileName:@"image.jpg" mimeType:@"image/jpeg"];
} completeBlock:^(id resultObject) {
PALog(@"resultObject: %@", resultObject);
} failureBlock:^(NSError *error) {
PALog(@"error: %@", error);
}];
// Print url
PALog(@"total url: %@", [[AFNPhalApiClient sharedClient] printTotalUrlStr]);
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | ret=400,客户端参数错误或非法请求 |
404 | 表示接口服务不存在 |
406 | ret=406,access_token令牌校验不通过 |
407 | ret=407,app_key权限不足,或未知应用 |
408 | ret=408,当前用户禁止使用,或用户未登录 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-04-27 12:03:01