Skip to main content
Skip table of contents

TikTok For Business

Setup & Authentication

You need to do the following to setup the TikTok For Business Connector:

  1. Create a TikTok for Business Account.

  2. Register as a developer.

  3. Create a developer app.

  4. Get an app ID and secret from your developer app.

Create a TikTok for Business Account

TikTok for Business' guide on how to create an account can be found here.

Register as a developer

TikTok for Business' guide on how to register as a developer can be found here.

Create a developer app

TikTok for Business' guide on how to create a developer app can be found here.

When creating the app set the fields as follows:

Field

Value

Advertiser redirect URL

Enter the Callback URL of your Cyclr Partner Console .
The URL is in the format: https://{Your Cyclr service domain e.g. app-h.cyclr.com}/connector/callback

Scope of permission

The following scopes need to be enabled for the connector to function correctly:

  • Ad Account Management > All

  • Ads Management > All

  • Audience Management > All

  • Creative Management > Image Management > Read Image Library,
    Create and Update Images

  • Creative Management > Instant Page Management > Instant Page Management

  • Creative Management > TikTok Posts Management > Query TikTok Posts, Authorize TikTok Posts, Create Identity, Query Identity, Delete Identity

  • Lead Management > All

It can take up to 10 minutes for changes to your app’s Advertiser redirect URL to be active.
During this time you may see errors relating to the URL when trying to authenticate a Connector.

Get an app ID and secret

Find your created app under the My Apps section of the TikTok for Business website here. Select the app you want to install the connector using and make note of the App ID and Secret. These are both required to install the TikTok for Business connector.

Cyclr setup

The TikTok For Business Connector can be used with two different authentication types:

  • Production Installation

  • Sandbox Installation

The Production installation should be used for live production accounts and the Sandbox installation should be used for sandbox accounts.

The Advertisers > List Advertisers Connector Method will not function when using the Sandbox installation.

Please see the additional information section for details on TikTok for Business sandbox account setup.

Console setup (production)

To setup the TikTok For Business Connector for Production use within your Cyclr console:

  1. Go to your Cyclr Console.

  2. Select Connectors > Application Connector Library at the top of the page.

  3. Use the search box to find the TikTok For Business Connector.

  4. Select the Setup Required icon.

  5. Enter the below values, omitting this step will allow you to use different settings for each account on installation:

Value

Description

Client ID

The app ID of your TikTok for Business app.

Client Secret

The secret of your TikTok for Business app.

  1. Select Save Changes.

Account setup (production)

You will be asked for the following values when installing the TikTok For Business Connector for Production use within an Account:

Value

Description

Environment

The environment to install the TikTok For Business Connector in.

Select Production.

Client ID

The app ID of your TikTok for Business account, if you did not enter this in step 5 above.

Client Secret

The secret of your TikTok for Business account, if you did not enter this in step 5 above.

Account setup (sandbox)

You will be asked for the following values when installing the TikTok For Business Connector for Sandbox use within an Account:

Value

Description

Environment

The environment to install the TikTok For Business Connector in.

Select Sandbox.

API Key

The access token of your TikTok for Business app sandbox ad account.

Additional Information

“Leads” Custom Object Category

The Leads Method Category should be copied to work with a specific TikTok form. This enables Cyclr to retrieve the fields of the form automatically.

When copying the Method Category, you’ll need to provide an Advertiser ID as well as a Page ID. Cyclr provides Connector Methods that retrieve those values on an authenticated TikTok For Business Connector.

From the Edit Connector page of your TikTok For Business Connector:

  1. Under the Methods and Fields heading, open the Advertisers Category.

  2. Open the List Advertisers Method then:

    1. Switch to the Test tab.

    2. Select Run to retrieve details of the Advertisers the Connector has access to:

      image-20240718-111140.png
    3. From the Return Values shown below the Method, copy the Advertiser ID you wish to work with for later.

  3. Open the Pages Category.

  4. Open the List Pages Method:

    1. Switch to the Test tab.

    2. Enter the Advertiser ID copied earlier into the Advertiser ID field.

    3. Select Run to retrieve details of the Pages (Forms) relevant to that Advertiser:

      image-20240718-111603.png
    4. From the Return Values shown below the Method, copy the Page ID for the Page you wish to work with for later.

  5. Go to the Leads (Name format: “advertiser ID, page ID”) Category and open it.

  6. Select the Copy Category button to see the popup below:

    image-20240718-112557.png
  7. Enter the Advertiser ID and Page ID from the earlier steps with a comma between them, e.g.:

    0000000000000000000, 8888888888888888888

  8. Select Copy.

  9. A new Method Category will be created using the Advertiser and Page IDs as its name:

    image-20240718-113019.png

  10. The Receive Leads Method contained in that Method Category will be setup to work with the selected Page and will have Custom Fields added for the fields in the TikTok Form. It’s then ready for use in an integration.

TikTok for Business sandbox account setup

TikTok for business has sandbox account functionality for testing. For more information on how to set up the sandbox account, see the TikTok for Business guide.

Make note of the Access Token you generate when you set it up as you need it to install the sandbox installation version of the connector.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.