TikTok Shop Partner Center API Configuration Lite Private Preview

For more information about authentication, accessing the Fivetran REST API, and request and response formats, see Getting Started with the Fivetran REST API.

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "tiktok_shop_partner_center",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "LOW",
  "data_delay_threshold": 0,
  "daily_sync_time": "14:00",
  "schedule_type": "auto",
  "connect_card_config": {
    "redirect_uri": "https://your.site/path",
    "hide_setup_guide": true,
    "all_fields": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "destination_schema_names": "FIVETRAN_NAMING",
  "external_secrets_manager_id": "esm_id",
  "config": {
    "app_key": "your_tiktok_shop_partner_center_app_key",
    "app_secret": "your_tiktok_shop_partner_center_app_secret",
    "authorization_url": "https://services.tiktokshops.us/open/authorize?service_id=7369437808455026474",
    "platform": "AMAZON",
    "schema": "schema_name"
  }
}

Config parameters

Name	Description
`app_key`	Your TikTok Shop Partner Center App key.
`app_secret`	Your TikTok Shop Partner Center App secret.
`authorization_url`	Your TikTok Shop Partner Center authorization URL.
`platform`	Your TikTok Shop Partner Center External Order Platform.
`schema` (required)	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

There are two ways to authorize this connector type:

By specifying the values for the app_key, app_secret and authorization_url parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "tiktok_shop_partner_center",
  "group_id": "group_id",
  "config": {
    "app_key": "your_tiktok_shop_partner_center_app_key",
    "app_secret": "your_tiktok_shop_partner_center_app_secret",
    "authorization_url": "https://services.tiktokshops.us/open/authorize?service_id=7369437808455026474"
  }
}

By using the Connect Card or the Fivetran dashboard.