{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e708ae26-3bc0-44cb-9441-5f105a6ea348","name":"TikTok API Resellers","description":"This is the official documentation for the API. \n\nIt lets you build your own service based on the services we provide. \n\nYou can view code examples in the dark area to the right; switch the programming language of the examples with the tabs in the top right.\n\nLicense: Apache 2.0 \n\n\n\n\n***********************************\n\n# Authentication\n\nThe API is JSON based.\n\nIn order to make an authenticated call to the API, you must include your Public Key and Private Key. We use two headers for this, X-Public-Key and X-Private-Key, they are passed along in every request in order to authenticate it.\n\n#### Register A Client\n\nIn order to use the API, you must have an active Reseller Account. \n\nAfter successfully registering a new application, you will be given a set of 2 unique keys:\n\n* PUBLIC_KEY \n* SECRET_KEY\n\n> Make sure to keep these keys secret. \n> These two keys are subsequently used to authenticate all your API calls.\n\n#### Authenticating A Request\n\nIn this step we'll teach you how to authenticate your requests.\n\nThe first thing you need to know is the parameters that go into generating the signature, these parameters are:\n\n* Private-Key\n* Public-Key\n\n> They are available in your reseller panel, after your application is accepted.\n\nSimply combine both Public-Key and Private-Key into an Header called X-Signature and the request will be authenticated.\n\nX-Signature is built in the following manner:\n\n\n    X-Public-Key&X-Private-Key\n\n\n#### Testing The Authentication\n\nUse the following request to test the Authentication:\n\n\n\tcurl -X GET /api/client/me/ \\\n\t  -H 'Accept: application/json' \\\n\t  -H 'X-Signature: {{public_key}}&{{private_key}}'\n\n\n> You can also use wget.\n\nYou can test your authentication headers via an API call.\nThis lets you know if your authentication module is fully operational.\n\n\n***********************\n\n\n# Errors\n\nInformation regarding Error Codes.\n\n#### Error Codes\n\n\n<table><thead>\n<tr>\n<th>Code</th>\n<th>Meaning</th>\n</tr>\n</thead><tbody>\n<tr>\n<td>invalid_input</td>\n<td>One of the inputs is invalid.</td>\n</tr>\n<tr>\n<td>json_error</td>\n<td>The json sent in the request is invalid.</td>\n</tr>\n<tr>\n<td>not_authenticated</td>\n<td>The Authorization token is either invalid or missing.</td>\n</tr>\n<tr>\n<td>permission_required</td>\n<td>The Authorization token doesnt grant permission for the action.</td>\n</tr>\n<tr>\n<td>account_has_no_permission</td>\n<td>The Account doesnt have permission to join the group.</td>\n</tr>\n<tr>\n<td>receiver_has_no_permission</td>\n<td>The Receiver doesnt have permission to join the group.</td>\n</tr>\n<tr>\n<td>account_and_receiver_have_no_permission</td>\n<td>The Receiver and Account both lack permission.</td>\n</tr>\n<tr>\n<td>two_factor_required</td>\n<td>The Account requires a Two Factor code to login.</td>\n</tr>\n<tr>\n<td>verification_required</td>\n<td>The Account requires verification.</td>\n</tr>\n<tr>\n<td>account_does_not_exist</td>\n<td>The Account does not exist.</td>\n</tr>\n<tr>\n<td>wrong_password</td>\n<td>The Account has wrong password.</td>\n</tr>\n<tr>\n<td>not_found_on_tiktok</td>\n<td>The Account or Receiver was not found on Tiktok.</td>\n</tr>\n<tr>\n<td>receiver_is_private</td>\n<td>The Receiver is private.</td>\n</tr>\n<tr>\n<td>editing_different_accounts</td>\n<td>The Account you're editing has a different ID.</td>\n</tr>\n<tr>\n<td>account_has_no_profile_picture</td>\n<td>The Account has no profile picture.</td>\n</tr>\n<tr>\n<td>account_already_exists</td>\n<td>The Account already exists in another user.</td>\n</tr>\n<tr>\n<td>subscription_expired</td>\n<td>The Subscription has already expired.</td>\n</tr>\n<tr>\n<td>max_likes_exceeded</td>\n<td>The number of likes selected surpasses the limit.</td>\n</tr>\n<tr>\n<td>no_receiver_selected</td>\n<td>No Receiver account selected.</td>\n</tr>\n<tr>\n<td>max_receivers_exceeded</td>\n<td>Only one Receiver account can be selected.</td>\n</tr>\n<tr>\n<td>group_not_suported</td>\n<td>Your Slot doesn't support that group.</td>\n</tr>\n<tr>\n<td>group_doesnt_exist</td>\n<td>The selected group doesnt exist.</td>\n</tr>\n<tr>\n<td>off_timer</td>\n<td>You must wait a few hours before activating the slot again.</td>\n</tr>\n<tr>\n<td>server_error</td>\n<td>There has been an issue with our servers.</td>\n</tr>\n<tr>\n<td>not_found</td>\n<td>One of the parameters were not found.</td>\n</tr>\n<tr>\n<td>missing_field</td>\n<td>One of the parameters is missing.</td>\n</tr>\n</tbody></table>\n\n\n*******************************\n\n# Webhooks\n\nEvery time an object is changed, either through the API or through our scripts (for example, if your receiver account goes private, and your slots are deactivated), we send a Webhook you can use to use to keep your system synchronized.\n\nOur webhooks have the following model:\n\n\n* key - Represents the type of the webhook\n* data - The object which was changed (we send the whole object)\n* date - A timestamp of the moment in which the change occured\n\n\nThese are the possible keys for the webhooks:\n\n* account_changed\n* account_deleted\n* receiver_changed \n* receiver_deleted\n* settings_changed","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6602131","team":1833100,"collectionId":"e708ae26-3bc0-44cb-9441-5f105a6ea348","publishedId":"TVYJ6HHT","public":true,"publicUrl":"https://documenter-api.postman.tech/view/6602131/TVYJ6HHT","privateUrl":"https://go.postman.co/documentation/6602131-e708ae26-3bc0-44cb-9441-5f105a6ea348","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"D632AB"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.11.5","publishDate":"2020-10-29T15:05:43.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/10fe41180dbaee1c771bf170dc2e8105cebbcd52a552787dc2b15641cc65bfc1","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/TVYJ6HHT"}