Modify Footer Settings

Updated: 2023-01-05 23:50:56

API Description

1、修改全局页脚设置
2、接口支持https协议

API URL

http://api.polyv.net/live/v4/user/global-setting/footer/update

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended for security. API calls have frequency limits. See details
If showFooterEnabled, footerText, footTextLinkProtocol, and footTextLinkUrl are not passed, they will not be modified by default.

Request Parameters Description

Parameter	Required	Type	Description
appId	true	String	Account appId See details on obtaining keys
timestamp	true	Long	Current 13-digit millisecond timestamp, valid for 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security. It must never be stored or used directly on the client side. All API calls must be relayed through your own server to the POLYV server for response data.` See signature generation rules

Request Body Parameters Description

Parameter	Required	Type	Description
showFooterEnabled	false	String	Whether to enable the footer Y: Enable N: Disable
footerText	false	String	Footer text, maximum length 12
footTextLinkProtocol	false	String	Footer link protocol header http:// or https://
footTextLinkUrl	false	String	Footer link URL, maximum length 50, do not include the protocol. `例如：www.polyv.net`

Example

http://api.polyv.net/live/v4/user/global-setting/footer/update?appId=frlr1zazn3&sign=488A9283731A8D3552593050E0081206&timestamp=1672884857202

Request body parameters:

{
    "footerText": "保利威提供技术支持",
    "footTextLinkUrl": "www.polyv.net",
    "showFooterEnabled": "Y",
    "footTextLinkProtocol": "https://"
}

Response Parameters Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine the basic response status
status	String	Response result, determined by the business. Returns `success` on success, `error` on failure
success	Boolean	Whether the response was successful
requestId	String	Request ID, a unique UUID generated for each request. Only used for troubleshooting and debugging, not for business logic
error	Object	Error information when the status code is not 200 See Error field description
data	Boolean	Returns `true` on success, empty on failure

Error Parameters Description

Parameter	Type	Description
code	Integer	Error code, used to identify the specific error reason
desc	String	Error description, corresponding to error.code

Java Request Example

For quick integration of basic code, download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and LiveSignUtil.java in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pooling.

/**
 * 修改页脚设置
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void updateGlobalFooterSettingTest() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    
    //业务参数
    String url = "http://api.polyv.net/live/v4/user/global-setting/footer/update";
    String showFooterEnabled = "Y";
    String footerText = "保利威提供技术支持";
    String footTextLinkProtocol = "https://";
    String footTextLinkUrl = "www.polyv.net";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    
    Map<String, Object> jsonMap = new HashMap<>();
    jsonMap.put("showFooterEnabled", showFooterEnabled);
    jsonMap.put("footerText", footerText);
    jsonMap.put("footTextLinkProtocol", footTextLinkProtocol);
    jsonMap.put("footTextLinkUrl", footTextLinkUrl);
    
    url = HttpUtil.appendUrl(url, requestMap);
    String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
    
    log.info("测试修改页脚设置成功：{}", response);
    //do somethings
    
}

Response Example

For global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "f14199d88cde4db4920d1fc1deb5d2d2.64.16728213873928631",
    "data": true,
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}