基本说明：
| 接口地址：http://api.avatardata.cn/TongYiCi/LookUp |
|---|
| 返回格式：json/xml |
| 请求方式：get/post |
| 请求示例：http://api.avatardata.cn/TongYiCi/LookUp?key=[您申请的APPKEY]&ciyu=点石成金 |
请求参数说明：
| 名称 | 类型 | 必填 | 说明 |
|---|---|---|---|
| key | String | 必填 | 应用APPKEY 扫码关注公众号 |
| dtype | String | 选填 | 返回结果格式：可选JSON/XML，默认为JSON |
| format | Boolean | 选填 | 当返回结果格式为JSON时，是否对其进行格式化，为了节省流量默认为false，测试时您可以传入true来熟悉返回内容 |
返回参数说明：
| 名称 | 类型 | 说明 |
|---|---|---|
| 参考JSON返回示例 | - | - |
JSON返回示例：
{
"result": [{
"group": "Hg18",
"ciyu": "点染"
},
{
"group": "Hg18",
"ciyu": "点石成金"
},
{
"group": "Hg18",
"ciyu": "点金成铁"
},
{
"group": "Hg18",
"ciyu": "订正"
},
{
"group": "Hg18",
"ciyu": "斧正"
},
{
"group": "Hg18",
"ciyu": "斧削"
},
{
"group": "Hg18",
"ciyu": "改"
},
{
"group": "Hg18",
"ciyu": "改易"
},
{
"group": "Hg18",
"ciyu": "改动"
},
{
"group": "Hg18",
"ciyu": "更正"
},
{
"group": "Hg18",
"ciyu": "勾"
},
{
"group": "Hg18",
"ciyu": "笔削"
},
{
"group": "Hg18",
"ciyu": "补苴罅漏"
},
{
"group": "Hg18",
"ciyu": "呈正"
},
{
"group": "Hg18",
"ciyu": "除去"
},
{
"group": "Hg18",
"ciyu": "雌黄"
},
{
"group": "Hg18",
"ciyu": "窜"
},
{
"group": "Hg18",
"ciyu": "窜改"
},
{
"group": "Hg18",
"ciyu": "打腹稿"
},
{
"group": "Hg18",
"ciyu": "就正"
},
{
"group": "Hg18",
"ciyu": "刊正"
},
{
"group": "Hg18",
"ciyu": "刊误"
},
{
"group": "Hg18",
"ciyu": "刊落"
},
{
"group": "Hg18",
"ciyu": "刊谬补缺"
},
{
"group": "Hg18",
"ciyu": "勘正"
},
{
"group": "Hg18",
"ciyu": "勘误"
},
{
"group": "Hg18",
"ciyu": "考订"
},
{
"group": "Hg18",
"ciyu": "匡"
},
{
"group": "Hg18",
"ciyu": "匡正"
},
{
"group": "Hg18",
"ciyu": "修订"
},
{
"group": "Hg18",
"ciyu": "修正"
},
{
"group": "Hg18",
"ciyu": "修改"
},
{
"group": "Hg18",
"ciyu": "修饰"
},
{
"group": "Hg18",
"ciyu": "审订"
},
{
"group": "Hg18",
"ciyu": "是正"
},
{
"group": "Hg18",
"ciyu": "剔"
},
{
"group": "Hg18",
"ciyu": "剔除"
},
{
"group": "Hg18",
"ciyu": "涂乙"
},
{
"group": "Hg18",
"ciyu": "削正"
},
{
"group": "Hg18",
"ciyu": "雅正"
},
{
"group": "Hg18",
"ciyu": "抹"
},
{
"group": "Hg18",
"ciyu": "去"
},
{
"group": "Hg18",
"ciyu": "去除"
},
{
"group": "Hg18",
"ciyu": "润色"
},
{
"group": "Hg18",
"ciyu": "润饰"
},
{
"group": "Hg18",
"ciyu": "删"
},
{
"group": "Hg18",
"ciyu": "删节"
},
{
"group": "Hg18",
"ciyu": "删改"
},
{
"group": "Hg18",
"ciyu": "删削"
},
{
"group": "Hg18",
"ciyu": "删除"
},
{
"group": "Hg18",
"ciyu": "删略"
},
{
"group": "Hg18",
"ciyu": "删繁就简"
},
{
"group": "Hg18",
"ciyu": "芟除"
},
{
"group": "Hg18",
"ciyu": "郢正"
},
{
"group": "Hg18",
"ciyu": "正误"
},
{
"group": "Hg18",
"ciyu": "指正"
}
],
"error_code": 0,
"reason": "Succes"
}
服务级错误码参照
| 错误码 | 说明 |
|---|---|
| 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/TongYiCi/LookUp?key=[您申请的APPKEY]&ciyu=点石成金';
/**
* 将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;
}
}