API调用

步骤一：在" API管理—我的API—API申请-已审批`"页面查看申请通过的API。点击API名称，查看API详情.

步骤二：在"`我的API—API详情"中查看API的调用URL和API请求示例。了解API调用时Query、Headers、Body中需填写的参数和格式。

步骤三：API-Token方式在"`我的API—API详情"中查看API-TOKEN。AK/SK方式在"我的API—API调用"页面查看APP Key和APP Secret，并根据APP Secret生成签名。

API签名生成方法详见API签名

步骤四：根据步骤二中的请求示例进行正式的传参调用。

一般来讲，调用规范如下：

Query:填写API的调用URL；
Header:填写API的请求头文件，API-TOKEN方式中仅包含API-TOKEN,AK/SK方式包含以下内容

X-Auth-Key = "APP Key"; //请求的APP Key。请到「我的API-API调用」页面查看APP Key ；
X-Auth-ActionId = "API Id"; //请求API的API Id。每个API拥有唯一的API Id，请到「我的API-API详情」中查看API ID；
X-Auth-Signature = "X-Auth-Signature"; //请求的签名。X-Auth-Signature根据APP Secret生成。
X-Auth-Timestamp = "X-Auth-Timestamp"; //时间戳。
Custom-Parameters="Custom_Parameters"; //自定义参数。填写API在Header中的输入参数。

Body:填写位于Body位置的输入参数；

API的调用方式自V3.6版本后，已修改为AK/SK的加密调用方式，但是仍可兼容之前版本的Token调用方式，不影响老API的使用。对于老API，用户可继续使用原有Token加密方式，也可切换至AK/SK的加密方式。

AK/SK认证方式客户端代码调用示例

curl 调用示例：

 curl  -H "Content-Type:application/json" -H "X-Auth-Key:27182828" -H "X-Auth-ActionId:1981" -H "X-Auth-Signature:6e3d641f601612cba26f4303145cc74a" -H "X-Auth-Timestamp:1563968688133" -X POST  -d '{"inFields":{"order_id":"10000005"}}'   http://api.dataq_eco.com/api/gateway/call/test_api_demo

curl返回结果示例：

{
    "data":[
        {"order_amount":854.65,
        "order_time":"2019-05-09 20:06:27.0",
        "shop_name":"天猫"}],
    "errorCode":1,
    "errorInfo":"成功",
    "space":0,
    "success":true
    }

HBase 返回结果示例：

{
    "data":[
        {
            "or1:order_amount":854.65,
            "rowkey":"123",
            "timestamp":1626339237156
        },
        {
            "or2:order_time":"2019-05-09 20:06:27.0",
            "rowkey":"345",
            "timestamp":1676339237143
        },
        {
            "or3:shop_name":"天猫",
            "rowkey":"678",
            "timestamp":1616349237139
        }],
    "errorCode":1,
    "errorInfo":"成功",
    "space":0,
    "success":true
    }

数据缓存

系统会将上一次的查询结果缓存在系统的HBase数据库，如果之后用户发起同样的请求，可以通过查HBase数据库的方式快速得到结果的返回，适用于生成和注册API的查询场景。

数据缓存的开启步骤：
1.用户需提供HBase数据库，建议该HBase数据库仅用于数据缓存。
2.在配置文件中开启“数据缓存”，并配置步骤1中的HBase数据库。

可以自定义设置缓存清理周期与时间，也可以手动清除缓存。