General Description
Common request headers
The table below outlines the common headers included in all tag service APIs. Standard HTTP headers are not listed here.
| Header | Required or not | Description |
|---|---|---|
| Authorization | Required | Include Access Key and request signature. |
| Content-Type | Optional | application/json; charset=utf-8 |
| x-bce-date | Optional | A string representing the date, compliant with BCE API specifications. |
| x-bce-content-sha256 | Optional | A hexadecimal string representing the SHA256 signature of the content body. This refers to the HTTP Request Payload Body—namely, the original data of the content part before HTTP encoding. |
Common headers are present in every tag service API and are mandatory. The header x-bce-content-sha256 is only included in POST and PUT requests.
Request data for POST, PUT, DELETE, and other operations should be placed within the request body.
Common response headers
The table below outlines the common response headers applicable to all tag service APIs. Standard HTTP response headers are not listed here.
| Header | Description |
|---|---|
| Content-Type | Only JSON format is supported: application/json; charset=utf-8 |
| x-bce-request-id | They are generated by the tag backend and automatically set in the response header fields. |
The request ID is created using UUID Version 4.
Common error response
Error responses from the tag service adhere to the BCE specification, with consistent formats demonstrated below. They will not be detailed separately for subsequent interfaces.
1 {
2 "requestId": "47e0ef1a-9bf2-11e1-9279-0100e8cf109a",
3 "code":"NoSuchKey",
4 "message":"The resource you requested does not exist"
5 }Here, "code" represents the error code. All error codes come from BCE global error codes and tag service-specific error codes (see the Error Codes section).
API version
The current API version is 1, indicating that the value of {version} in the following sections should be set to 1.