HackApi - API 接口、调试、文档、数据一体化协作平台

开发文档
调试工具
错误参照
示例代码

接口地址： https://api.hackeus.cn/api/baike

请求协议： HTTP、HTTPS

请求方式： GET/POST

返回格式： JSON

请求示例： https://api.hackeus.cn/api/baike?api_key=您的apiKey&type=Baidu&word=Api

请求参数说明：

名称	必填	类型	说明
api_key	是	String	登录后获取api_key
type	是	String	百科类型(Baidu=百度;Sogo=搜狗)
word	是	String	关键词如：Api

返回参数说明：

名称	必填	类型	说明
content	否	String	百科正文内容
ImgUrl	否	String	百科图片链接

返回示例代码：

{
      "code": 200,
      "msg": "success",
      "data": {
            "content": "API之主要目的是提供应用程序与开发人员以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。提供API所定义的功能的软件称作此API的实现。API是一种接口，故而是一种抽象。应用程序接口（英语：Application Programming Interface，简称：API），又称为应用编程接口，就是软件系统不同组成部分衔接的约定。由于近年来软件的规模日益庞大，常常需要把复杂的系统划分成小的组成部分，编程接口的设计十分重要。程序设计的实践中，编程接口的设计首先要使软件系统的职责得到合理划分。良好的接口设计可以降低系统各部分的相互依赖，提高组成单元的内聚性，降低组成单元间的耦合程度，从而提高系统的维护性和扩展性。\" ",
            "ImgUrl": "https://bkimg.cdn.bcebos.com/pic/5ab5c9ea15ce36d36b3c21233ef33a87e950b1ed?x-bce-process=image/resize,m_lfit,w_536,limit_1/format,f_jpg"
      }
}

调试工具支持的请求类型有： GET、POST、PUT、HEAD、TRACE、DELETE、CONNECT、OPTIONS。状态码释义请前往帮助文档进行查看。

请求参数设置：

参数名称	参数值	操作

请求返回结果：

{
      "code": 200,
      "msg": "success",
      "data": {
            "content": "API之主要目的是提供应用程序与开发人员以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。提供API所定义的功能的软件称作此API的实现。API是一种接口，故而是一种抽象。应用程序接口（英语：Application Programming Interface，简称：API），又称为应用编程接口，就是软件系统不同组成部分衔接的约定。由于近年来软件的规模日益庞大，常常需要把复杂的系统划分成小的组成部分，编程接口的设计十分重要。程序设计的实践中，编程接口的设计首先要使软件系统的职责得到合理划分。良好的接口设计可以降低系统各部分的相互依赖，提高组成单元的内聚性，降低组成单元间的耦合程度，从而提高系统的维护性和扩展性。\" ",
            "ImgUrl": "https://bkimg.cdn.bcebos.com/pic/5ab5c9ea15ce36d36b3c21233ef33a87e950b1ed?x-bce-process=image/resize,m_lfit,w_536,limit_1/format,f_jpg"
      }
}

错误码格式说明：

错误码	类型	说明
code	String	200表示成功，非200表示出错
msg	String	返回的状态信息

系统状态码参照：

状态码	含义	解决方法
10000	缺失KEY	前往登录会员中心获取KEY
10001	无此KEY	请检查KEY是否填写正确
10002	KEY已过期	请求接口已到期，需要续费
10003	付费接口	前往登录会员中心购买接口
10004	非法访问	IP地址不在白名单中填写IP
10005	QPS限制	请求频率过高，请等待解锁
10006	接口维护	接口维护中，等待维护完毕
10007	接口下架	接口已下架，停止接口服务
10008	状态错误	接口状态错误，请联系客服
10009	无此接口	请求方法不支持，没有接口
10010	鉴权签名	鉴权已开启，请输入签名
10011	签名过期	签名已过期请及时续费签名
10012	签名不正确	签名输入不正确，重新输入

完整示例代码：

                                       No sample HackApi Provide Api Service
                 ┌───┐   ┌───┬───┬───┬───┐ ┌───┬───┬───┬───┐ ┌───┬───┬───┬───┐ ┌───┬───┬───┐
                 │Esc│   │ F1│ F2│ F3│ F4│ │ F5│ F6│ F7│ F8│ │ F9│F10│F11│F12│ │P/S│S L│P/B│  ┌┐    ┌┐    ┌┐
                 └───┘   └───┴───┴───┴───┘ └───┴───┴───┴───┘ └───┴───┴───┴───┘ └───┴───┴───┘  └┘    └┘    └┘
                 ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐ ┌───┬───┬───┐ ┌───┬───┬───┬───┐
                 │~ `│! 1│@ 2│# 3│$ 4│% 5│^ 6│& 7│* 8│( 9│) 0│_ -│+ =│ BacSp │ │Ins│Hom│PUp│ │N L│ / │ * │ - │
                 ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤ ├───┼───┼───┤ ├───┼───┼───┼───┤
                 │ Tab │ Q │ W │ E │ R │ T │ Y │ U │ I │ O │ P │{ [│} ]│ | \ │ │Del│End│PDn│ │ 7 │ 8 │ 9 │   │
                 ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤ └───┴───┴───┘ ├───┼───┼───┤ + │
                 │ Caps │ A │ S │ D │ F │ G │ H │ J │ K │ L │: ;│" '│ Enter  │               │ 4 │ 5 │ 6 │   │
                 ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────────┤     ┌───┐     ├───┼───┼───┼───┤
                 │ Shift  │ Z │ X │ C │ V │ B │ N │ M │< ,│> .│? /│  Shift   │     │ ↑ │     │ 1 │ 2 │ 3 │   │
                 ├─────┬──┴─┬─┴──┬┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬────┬────┤ ┌───┼───┼───┐ ├───┴───┼───┤ E││
                 │ Ctrl│    │Alt │         Space         │ Alt│    │    │Ctrl│ │ ← │ ↓ │ → │ │   0   │ . │←─┘│
                 └─────┴────┴────┴───────────────────────┴────┴────┴────┴────┘ └───┴───┴───┘ └───────┴───┴───┘