1. 添加推广链接

POST /v1/api/introduce/create

通过此接口开通BW推广链接。

Request Headers

Name Required Type Description
x-api-tenantId yes string 租户编号
x-api-token yes string 认证token
x-language no string 语言，zh-CN、en-US

Request Body Parameters

Name Required Type Description
name yes string 推广名称
entityNo no string 推广编码，没传则自动生成
introduceType yes string Agent/StraightGuest
visibleType yes string UserAllVisible/UserPartVisible/UserNotVisible
visibleUserId no array 可见用户ID，如果设置了UserPartVisible，则必须填写
targetUrl no/如果introduceType=StraightGuest，则必填 string 目标链接
parameterType no string 参数类型，uid/pid/sid
serverId no string manager server id
vendor no bool 是否发送邮件，如果没传密码则肯定发送邮件
mtGroup no string 默认MT组
accountGroup no int 默认账户组ID
leverage no int 默认杠杆
ownerType no string 默认归属类型，值为RoleId/Id
ownerId no string 默认归属ID，只有WEB和不展示BW用户的才有该值
ownerName no string 默认归属名，冗余字段，用于展示

Response

Name Type Description
result boolean 成功标识，返回true，表示请求成功，false表示请求失败
mcode string 错误码，成功时返回m00000，失败时返回对应的错误码，见文档默认错误码说明
data object 报表数据
errorMessage string 错误提示信息，部分错误码时有值
1、data数据类型
Name Type Description
name string 推广名称
entityNo string 推广编码，没传则自动生成
introduceType string Agent/StraightGuest
visibleType string UserAllVisible/UserPartVisible/UserNotVisible
visibleUserId array 可见用户ID，如果设置了UserPartVisible，则必须填写
targetUrl string 目标链接
displayUrl string 展示时使用的推广链接URL
parameterType string 参数类型，uid/pid/sid
serverId string manager server id
vendor bool 是否发送邮件，如果没传密码则肯定发送邮件
mtGroup string 默认MT组
accountGroup int 默认账户组ID
leverage int 默认杠杆
ownerType string 默认归属类型，值为RoleId/Id
ownerId string 默认归属ID，只有WEB和不展示BW用户的才有该值
ownerName string 默认归属名，冗余字段，用于展示

Example

请求示例

POST /v1/api/introduce/create
{    
    "entityNo":"EN03045"
    ,"name":"apiTest1234"
    , "introduceType":"Agent"
    , "visibleType":"UserPartVisible"
    , "visibleUserId":[1, 2]
    , "targetUrl":"http://www.baidu.com"
    , "parameterType":"uid"
    , "serverId":"428"
    , "vendor":"MT4"
    , "mtGroup":"test"
    , "accountGroup":"group1"
    , "leverage":"100"
    , "ownerType":"Id"
    , "ownerId":"4"
    , "ownerName":"哈哈 steven"
}

返回示例：成功

{    
"data": {
    "entityNo":"EN03045"
    ,"name":"apiTest1234"
    , "introduceType":"Agent"
    , "visibleType":"UserPartVisible"
    , "visibleUserId":[1, 2]
    , "targetUrl":"http://www.baidu.com",
    , "displayUrl":"http://broker.btmsc.lwork.com/introduce?iid=EN03045"
    , "parameterType":"uid"
    , "serverId":"428"
    , "vendor":"MT4"
    , "mtGroup":"test"
    , "accountGroup":"group1"
    , "leverage":"100"
    , "ownerType":"Id"
    , "ownerId":"4"
    , "ownerName":"哈哈 steven"

},
"mcode": "m0000000",
"result": true

}

返回示例：失败

{
    "mcode": "PUB_AUTH_0000007",
    "result": false
}

2. Error 错误处理

错误码表（Error Code）

mcode MessageBW_API_
BW_API_0000001 token为空
BW_API_0000003 无效租户ID
BW_API_0000004 未开通OPENAPI权限
BW_USER_INRR_NAME_NULL 用户名字为空
BW_USER_INRR_PARAM_ERROR 目标链接和parameterType参数重复
-1 服务异常，请稍后再试

results matching ""

    No results matching ""