TikTok Premium API
- arodriguez
- Zak Fareed
Overview
The TikTok Premium API shall be used for managing urls that enable Socialgist to provide customers with premium coverage of targeted TikTok content.
The TikTok Premium Rules API has the following endpoints:
List TikTok Urls
Add TikTok urls (author, tag)
Delete TikTok Urls
API Reference
List TikTok Urls
Lists the customer’s TikTok subscription list of TikTok urls.
Request URL
HTTP Method: GET
Response Contents
A list of TikTok objects associated with each API key or customer ID
Object Field | Sample | Notes |
|---|---|---|
|
|
|
|
|
|
|
|
|
Pagination
To page through a large result set, the ‘pageable’ object is included in the response to facilitate the process of paging through the full dataset.
{ "pageable": {
"sort": {
"sorted": false,
"unsorted": true,
"empty": true
},
"pageNumber": 0,
"pageSize": 10,
"offset": 0,
"paged": true,
"unpaged": false
},
"totalPages": 2,
"totalElements": 20,
"last": false,
"numberOfElements": 20,
"size": 20,
"number": 0,
"first": true,
"sort": {
"sorted": false,
"unsorted": true,
"empty": true
},
"empty": false
}
The following parameters should be included in the follow-up request:
page={pagenum)&size={pagesize}
Using incremental page numbers 1-{totalPages} value, the user could traverse the result set and on each page the pageable object is included. The offset value is not required as the division of the dataset is handled automatically.
Sample Request
https://apis.socialgist.com/tiktok_premium_api/customerabc/tiktok/main/seedurls/listp?page=0&size=2
Sample Response
Status – 200 OK
{
"content": [
{
"seedUrl": "https://www.tiktok.com/@lorengray",
"seedName": "lorengray",
"dateAdded": "2024-05-29T17:57:15.626+00:00"
},
{
"seedUrl": "https://www.tiktok.com/@yellowlemontree",
"seedName": "yellowlemontree",
"dateAdded": "2024-05-29T22:07:56.707+00:00"
}
]
}
"totalElements": 20,
"last": false,
"numberOfElements": 20,
"size": 20,
"number": 0,
"first": true,
"sort": {
"sorted": false,
"unsorted": true,
"empty": true
},
"empty": false
}
The following parameters should be included in the follow-up request:
page={pagenum)&size={pagesize}
Using incremental page numbers 1-{totalPages} value, the user could traverse the result set and on each page the pageable object is included. The offset value is not required as the division of the dataset is handled automatically.
Add TikTok Url
Submits a TikTok subscription to the customer’s Premium TikTok data stream. TikTok Urls must be added one at a time and this is accomplished by including the url in the body submission.
Request URL
https://apis.socialgist.com/tiktok_premium_api/{customer}/tiktok/{apipath}/seedurls
HTTP Method: POST
Sample Request
https://apis.socialgist.com/tiktok_premium_api/customerabc/tiktok/main/seedurls
Body
{
"content":{
"url":"https://www.tiktok.com/tag/walmartcmn"
}
}
Sample Response
Status - 20O OK
{"response":"SUCCESS"}
Delete TikTok Url
Deletes a TikTok subscription from the customer’s Premium TikTok data stream. TikTok Urls must be deleted one at a time and this is accomplished by including the url in the body submission.
Request URL
https://apis.socialgist.com/tiktok_premium_api/{customer}/tiktok/{apipath}/seedurls
HTTP Method: DELETE
Sample Request
https://apis.socialgist.com/TikTok_premium_api/customerabc/TikTok/main/seedurls
Body
{
"content":{
"url":"https://www.tiktok.com/tag/nfl"
}
}
Sample Response
Status - 20O OK
{"response":"SUCCESS"}