接口地址:http://api.avatardata.cn/XinHuaZiDian/LookUp |
---|
返回格式:json/xml |
请求方式:get/post |
请求示例:https://www.avatardata.cn/Docs/Api/1764dbac-1d91-408c-9bdc-0f361fc4c15f |
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
key | String | 必填 | 应用APPKEY 扫码关注公众号 |
content | String | 必填 | 需要从字典中查找的汉字字符串,可一次查多个汉字,最多一次查50个,超出部分将截断 |
dtype | String | 选填 | 返回结果格式:可选JSON/XML,默认为JSON |
format | Boolean | 选填 | 当返回结果格式为JSON时,是否对其进行格式化,为了节省流量默认为false,测试时您可以传入true来熟悉返回内容 |
名称 | 类型 | 说明 |
---|---|---|
参考JSON返回示例 | - | - |
{
"error_code": 0,
"reason": "Succes",
"result": [{
"id": "f59f6777-2699-402c-a654-280144c6209f",
"hanzi": "中",
"pinyin": "zhong",
"duyin": "zhòng,zhōng",
"bushou": "丨",
"bihua": 4,
"jianjie": "中 zhōng 和四方、上下或两端距离同等的地位:中心。......",
"xiangjie": "中<br>zhōng<br>【名】<br>(指事。甲骨文字形,中象旗杆,上下......"
},
{
"id": "6f1ebe67-51e4-4c37-9653-97859c7b00e2",
"hanzi": "国",
"pinyin": "guo",
"duyin": "guó",
"bushou": "囗",
"bihua": 8,
"jianjie": "国 (國) guó 有土地、人民、主权的政体......",
"xiangjie": "国<br>囯、國<br>guó<br>【名】<br>(会意。从“囗”(wéi),表示......"
}
]
}
错误码 | 说明 |
---|---|
0 | 请求成功 |
1 | 参数错误 |
10001 | 错误的请求KEY |
10002 | 该KEY无请求权限 |
10003 | KEY过期 |
10004 | 错误的OPENID |
10005 | 应用未审核超时,请提交认证 |
10006 | 未知的请求源 |
10007 | 被禁止的IP |
10008 | 被禁止的KEY |
10009 | 当前IP请求超过限制 |
10010 | 请求超过次数限制,请购买套餐 |
10011 | 账户余额不足,请充值 |
10012 | 测试KEY超过请求限制 |
10013 | 请求错误,请重试 |
10014 | 接口维护 |
10015 | 接口停用 |
10016 | 当日调用次数到达上限,请明日重试或联系我们申请更多上限次数 |
<?php
/**
* Created by PhpStorm.
* User: FZS
* Time: 2019/3/15 17:50
*/
//----------------------------------
// 阿凡达数据 新华字典 调用类
//----------------------------------
class freeApi{
private $apiUrl = 'http://api.avatardata.cn/XinHuaZiDian/LookUp?key=[您申请的APPKEY]&content=我是中国人';
/**
* 将JSON内容转为数据,并返回
* @param string $content [内容]
* @return array
*/
public function returnArray($content){
return json_decode($content,true);
}
/**
* 获取 新华字典 结果
* @return array
*/
public function getResult(){
return $this->returnArray($this->freeApiCurl($this->apiUrl));
}
/**
* 请求接口返回内容
* @param string $url [请求的URL地址]
* @param string $params [请求的参数]
* @param int $ipost [是否采用POST形式]
* @return string
*/
public function freeApiCurl($url,$params=false,$ispost=0){
$ch = curl_init();
curl_setopt( $ch, CURLOPT_HTTP_VERSION , CURL_HTTP_VERSION_1_1 );
curl_setopt( $ch, CURLOPT_HTTP_VERSION , CURL_HTTP_VERSION_1_1 );
curl_setopt( $ch, CURLOPT_USERAGENT , 'free-api' );
curl_setopt( $ch, CURLOPT_CONNECTTIMEOUT , 60 );
curl_setopt( $ch, CURLOPT_TIMEOUT , 60);
curl_setopt( $ch, CURLOPT_RETURNTRANSFER , true );
if( $ispost )
{
curl_setopt( $ch , CURLOPT_POST , true );
curl_setopt( $ch , CURLOPT_POSTFIELDS , $params );
curl_setopt( $ch , CURLOPT_URL , $url );
}
else
{
if($params){
curl_setopt( $ch , CURLOPT_URL , $url.'?'.$params );
}else{
curl_setopt( $ch , CURLOPT_URL , $url);
}
}
$response = curl_exec( $ch );
if ($response === FALSE) {
return false;
}
curl_close( $ch );
return $response;
}
}