HTTP/HTTPS
请求协议
YesDev / OpenAPI / 首页
首页
接口地址:http://test.www.yesdev.cn/api/app.php?s=App.Site.Index
接口描述: 默认接口服务,当未指定接口服务时执行此接口服务
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
app_key | 字符串 | 可选 | app_key,团队代码 | ||
sign | 字符串 | 可选 | - | 动态签名,签名算法请联系我们技术客服获取 |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
data.title | 字符串 | 标题 |
data.version | 字符串 | 版本,格式:X.X.X |
data.time | 整型 | 当前时间戳 |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
app_key | 可选 | |
sign | 可选 |
客户端请求示例
{
"ret": 200,
"data": {
"title": "Hello PhalApi",
"version": "2.7.0",
"time": 1558489902
},
"msg": ""
}
curl http://test.www.yesdev.cn/api/app.php?s=App.Site.Index&username=PhalApi
{"ret":200,"data":{"title":"Hello PhalApi","version":"2.13.1","time":1585536376},"msg":""}
$.ajax({
url: "http://test.www.yesdev.cn/api/app.php",
data: {s: "App.Site.Index", username: "PhalApi"},
dataType: 'json',
success: function (response, status, xhr) {
console.log(response);
}
});
<?php
require_once dirname(__FILE__) . '/PhalApiClient.php';
$client = PhalApiClient::create()
->withHost('http://test.www.yesdev.cn/api/app.php');$rs = $client->reset()
->withService('App.Site.Index')
->withParams('username', 'PhalApi')
->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('http://test.www.yesdev.cn/api/app.php', 'App.Site.Indexx', {'username': 'PhalApi'}, 3)
//FullscreenActivity.java
import net.phalapi.sdk.*; /**
* 网络操作相关的子线程
*/
Runnable networkTask = new Runnable() {
@Override
public void run() {
// TODO
// 在这里进行 http request.网络请求相关操作
PhalApiClient client = PhalApiClient.create()
.withHost("http://test.www.yesdev.cn/api/app.php");
PhalApiClientResponse response = client
.withService("App.Site.Index")
.withParams("username", "dogstar")
.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("http://demo.phalapi.net/")
.withService("Default.Index")
.withparamsList("name", "dogstar")
.withTimeout(3000)
.request();
Log.v("response ret", response.ret + "");
Log.v("response data", response.data);
Log.v("response msg", response.msg);
package main
import (
"./PhalApiClient"
"fmt"
"net/url"
)
func main() {
rs, err := PhalApiClient.NewRequest().
WithHost(`http://test.www.yesdev.cn/api/app.php`).
WithService("App.Site.Index").
WithParams(url.Values{}).
Get()
if err != nil {
fmt.Println(err.Error())
} else {
fmt.Println("code------------------------", rs.Code)
fmt.Println("data------------------------", rs.Data)
fmt.Println("msg------------------------", rs.Msg)
}
}
#import "AFNPhalApiClient.h"// 待POST的参数
NSDictionary *params = @{@"demo_key_1": @"your_key", @"demo_key_2": @"1.0"};
// 使用AFNPhalApiClient
[[[[[AFNPhalApiClient sharedClient] withHost:@"http://test.www.yesdev.cn/api/app.php"] withService:@"App.Site.Index"] 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);
}];
// 打印url查看
PALog(@"total url: %@", [[AFNPhalApiClient sharedClient] printTotalUrlStr]);
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | 非法请求,参数传递错误 |
404 | 表示接口服务不存在 |
500 | 表示服务端内部错误 |
本文档生成时间:2025-01-15 15:18:56 联系我们开通接入OpenAPI