Skip to main content

Tiktok-Marketing authentication

This page documents the authentication and configuration options for the Tiktok-Marketing agent connector.

Authentication​

Open source execution​

In open source mode, you provide API credentials directly to the connector.

OAuth​

credentials fields you need:

Field NameTypeRequiredDescription
access_tokenstrYesYour TikTok Marketing API access token

Example request:

from airbyte_agent_sdk.connectors.tiktok_marketing import TiktokMarketingConnector
from airbyte_agent_sdk.connectors.tiktok_marketing.models import TiktokMarketingAuthConfig

connector = TiktokMarketingConnector(
    auth_config=TiktokMarketingAuthConfig(
        access_token="<Your TikTok Marketing API access token>"
    )
)

Token​

This authentication method isn't available for this connector.

Hosted execution​

In hosted mode, you first create a connector via the Airbyte API (providing your OAuth or Token credentials), then execute operations using either the Python SDK or API. If you need a step-by-step guide, see the hosted execution tutorial.

OAuth​

Create a connector with OAuth credentials.

credentials fields you need:

Field NameTypeRequiredDescription
access_tokenstrYesYour TikTok Marketing API access token

replication_config fields you need:

Field NameTypeRequiredDescription
start_datestr (date)YesThe start date in YYYY-MM-DD format. Any data before this date will not be replicated. If not set, defaults to 2016-09-01.

Example request:

curl -X POST "https://api.airbyte.ai/api/v1/integrations/connectors" \
  -H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "workspace_name": "<WORKSPACE_NAME>",
    "connector_type": "Tiktok-Marketing",
    "name": "My Tiktok-Marketing Connector",
    "credentials": {
      "access_token": "<Your TikTok Marketing API access token>"
    },
    "replication_config": {
      "start_date": "<The start date in YYYY-MM-DD format. Any data before this date will not be replicated. If not set, defaults to 2016-09-01.>"
    }
  }'

Bring your own OAuth flow​

To implement your own OAuth flow, use Airbyte's server-side OAuth API endpoints. For a complete guide, see Build your own OAuth flow.

Step 1: Initiate the OAuth flow​

Request a consent URL for your user.

Field NameTypeRequiredDescription
workspace_namestringYesYour unique identifier for the workspace
connector_typestringYesThe connector type (e.g., "Tiktok-Marketing")
redirect_urlstringYesURL to redirect to after OAuth authorization

Example request:

curl -X POST "https://api.airbyte.ai/api/v1/integrations/connectors/oauth/initiate" \
  -H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "workspace_name": "<WORKSPACE_NAME>",
    "connector_type": "Tiktok-Marketing",
    "redirect_url": "https://yourapp.com/oauth/callback"
  }'

Redirect your user to the consent_url from the response.

Step 2: Handle the callback​

After the user authorizes access, Airbyte automatically creates the connector and redirects them to your redirect_url with a connector_id query parameter. You don't need to make a separate API call to create the connector.

https://yourapp.com/oauth/callback?connector_id=<connector_id>

Extract the connector_id from the callback URL and store it for future operations. For error handling and a complete implementation example, see Build your own OAuth flow.

Token​

This authentication method isn't available for this connector.

Execution​

After creating the connector, execute operations using either the Python SDK or API. If your Airbyte client can access multiple organizations, include organization_id in AirbyteAuthConfig and X-Organization-Id in raw API calls.

Python SDK

The connect() factory returns a fully typed TiktokMarketingConnector and reads AIRBYTE_CLIENT_ID / AIRBYTE_CLIENT_SECRET from the environment:

Pydantic AI
from airbyte_agent_sdk import connect
from airbyte_agent_sdk.connectors.tiktok_marketing import TiktokMarketingConnector

connector = connect("tiktok-marketing", workspace_name="<your_workspace_name>")

@agent.tool_plain
@TiktokMarketingConnector.tool_utils
async def tiktok_marketing_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Or pass credentials explicitly (equivalent, useful when you're not loading them from the environment): Pydantic AI

Pydantic AI
from airbyte_agent_sdk.connectors.tiktok_marketing import TiktokMarketingConnector
from airbyte_agent_sdk.types import AirbyteAuthConfig

connector = TiktokMarketingConnector(
    auth_config=AirbyteAuthConfig(
        workspace_name="<your_workspace_name>",
        organization_id="<your_organization_id>",  # Optional for multi-org clients
        airbyte_client_id="<your-client-id>",
        airbyte_client_secret="<your-client-secret>"
    )
)

@agent.tool_plain
@TiktokMarketingConnector.tool_utils
async def tiktok_marketing_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

API

curl -X POST 'https://api.airbyte.ai/api/v1/integrations/connectors/<connector_id>/execute' \
  -H 'Authorization: Bearer <YOUR_BEARER_TOKEN>' \
  -H 'X-Organization-Id: <YOUR_ORGANIZATION_ID>' \
  -H 'Content-Type: application/json' \
  -d '{"entity": "<entity>", "action": "<action>", "params": {}}'
Was this page helpful?