接口说明

1. 接口信息

请求地址：https://open.volcengineapi.com
协议：HTTPS
HttpMethod: POST
字符集：UTF-8
Content-Type: application/json

注意：content-type必须设置为application/json

2. 调用方式

为保证接口调用安全，调用风险识别服务提供的每个API时，都需要提供签名认证信息，服务调用有如下两种方式。

注意：鉴权时会把签名生成的时间戳与当前时间进行比较，如果相差超过2分钟会鉴权失败，这是为了防止重放攻击，请保持服务器时钟的准确。

火山引擎为用户封装了带签名算法的SDK，可以在如下地址取用：https://github.com/volcengine 使用SDK可以减少大量接入开发成本，并长期提供维护和升级、错误重试等适用于业务本地服务端执行的能力。

Go

版本说明：支持go 1.13.1及以上版本，如不支持，请联系火山引擎反作弊平台

import (
   "github.com/volcengine/volc-sdk-golang/service/adblocker"
)

const (
   *Ak* = "" // fill in your access key
   *Sk* = "" // fill in your secret key
)

func init() {
   adblocker.DefaultInstance.Client.SetAccessKey(*Ak*)
   adblocker.DefaultInstance.Client.SetSecretKey(*Sk*)
}

func AdBlock(appId int64, service string, parameters string) (*adblocker.AdBlockResponse, error) {
   return adblocker.DefaultInstance.AdBlock(&adblocker.AdBlockRequest{
      AppID:      appId,
      Service:    service,
      Parameters: parameters,
   })
}

Python

版本说明：支持Python2.7及以上版本，如不支持，请联系火山引擎反作弊平台

from volcengine.adblocker.AdBlockerService import AdBlockService
if __name__ == '__main__':
    adblocker = AdBlockService()
    # call below method if you dont set ak and sk in ～/.volc/config
    adblocker.set_ak('') # fill in your access key
    adblocker.set_sk('') # fill in your secret key

    params = dict()
    req = {
         'app_id': 0, # fill in your app id
         'service': "", # fill in the adblock service to be called
         'parameters': '{}' # fill in the parameters with json
    }
    resp = adblocker.ad_block(params, req)

PHP

版本说明：支持PHP7.0及以上版本，如不支持，请联系火山引擎反作弊平台

<?php
require('../../vendor/autoload.php');

use Volc\Service\AdBlocker;
$client = AdBlocker::*getInstance*();

// call below method if you dont set ak and sk in ～/.volc/config
$client->setAccessKey("ak");
$client->setSecretKey("sk");

// fill in your app id , ad block service and parameters
$response = $client->adBlock(0, "", "{}");
echo $response;

Java

版本说明：支持JDK8及以上版本，如不支持，请联系火山引擎反作弊平台

package com.volcengine.example.adblocker;

import com.alibaba.fastjson.JSON;
import com.volcengine.model.request.AdBlockerRequest;
import com.volcengine.model.response.AdBlockerResponse;
import com.volcengine.service.adblocker.AdBlockerServiceImpl;
import com.volcengine.service.adblocker;

public class RiskDetectionDemo {
    public static void main(String[] args) {
        AdBlockerService adblockerService = AdBlockerServiceImpl.getInstance();
        // call below method if you dont set ak and sk in ～/.volc/config

        adblockerService.setAccessKey("ak");
        adblockerService.setSecretKey("sk");
        // risk detection
        try {
            AdBlockerRequest adblockerRequest = new AdBlockerRequest();

            AdBlockerResponse AdBlockerResponse = adblockerService.AdBlock(adblockerRequest);
            System.out.println(JSON.toJSONString(AdBlockerResponse));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

C++

#include "../../service/adblocker/config.h"

int main() {
   AdBlocker ad_block;
   ad_block.client->SetAccessKey("ak");
   ad_block.client->SetSecretKey("sk");

   AdBlockRequestPtr req = std::make_shared<AdBlockRequest>();
   req->AppId = 218745;
   req->Service = "chat";
   req->Parameters = "{\"operate_time\": 1617344096}";

   AdBlockResponsePtr resp = std::make_shared<AdBlockResponse>();
   std::string err;
   ad_block.AdBlock(req, resp ,err);
}

3. AppId(应用ID)获取方式

火山引擎账户注册后，在火山引擎控制台的应用管理可创建新应用，或者选取已有应用将应用ID在公共请求参数章节中的AppId字段使用。

如创建应用过程中报错显示“Duplicated AppNameZh”，说明此前接入过其他火山引擎服务，可联系我方协助获取应用ID。

4. 密钥获取方式

完成火山引擎账户注册后，在火山引擎控制台点击右上角秘钥管理可以获取鉴权信息。

详情可参考：
火山引擎控制台-访问密钥（Access Key）