Tiktok for developers api example.
Developer Guidelines.
Tiktok for developers api example. Embedded for developers.
Tiktok for developers api example Here are some example scopes: user. basic gives read-only access to a user's avatar and display Key. Webhooks let you subscribe to events and receive notice when an event occurs. 1703186989 Most endpoints provided by TikTok for Developers require direct consent from TikTok users before you Users have the rights to only agree to a subset of scopes you requested from them. string. It is strongly recommended that webhook consumers verify these signatures before processing each webhook event. effect_id . com; Example video webpage; Embedded for developers. This guide Through integrating and calling the TikTok API for Business interface, developers can leverage our interface to interact with TikTok Ads Manager, TikTok Accounts and TikTok Creator Migrating to our new API. 5945 Likes, 40 Comments. The partner-facing user ID. 1703186989 Most endpoints provided by TikTok for Developers require direct consent from TikTok users before you can invoke them. Query TikTok public content data. No We're launching our official TikTok for Developers YouTube channel for our community to explore TikTok's tools, APIs, and developer insights, including exclusive content from TikTok DevDay. To ensure a successful submission to the Data Portability API, please review these guidelines for each question carefully, including the FAQ. Once your application is approved, a research client will be generated for your project. Create a ShareApi to send a share request. video_description. max_count. UTC Unix timestamp at which the data collection was requested. scope. ; Create a ShareRequest object and set the required parameters. TikTok has rapidly grown into one of the most popular social media platforms, attracting users and businesses alike. In order to access our Research Tools, you will need to meet our eligibility requirements, submit an application, and be approved for a specific research project. *. Learn how to obtain the access token and open ID. It is valid for 2 hours after the initial issuance. It is possible that the API returns fewer videos than the max count due to content moderation outcomes, UTC Unix epoch (in seconds) of when the TikTok video was posted "username" string. has_more is true, pass in the response. Prerequisites. request_id. Open the video webpage on tiktok. token_type. The video/query/ endpoint, given a user and a list of video ids, can check if the videos belong to the requesting user and fetch the data of videos belonging to the user. View your client registration. The app icon must be a clear image. In addition, you can design features to This guide will show you how to get an authorization code and an access token in order to utilize the Display APIs. Additional data access may require approval for additional Scopes. Note: the cursor value is a UTC Unix timestamp in milli-seconds. Use the /v2/user/info/ API to get a TikTok user's profile data and then display their TikTok identity. Docs Support Blog. Up to 20 video IDs can be included per request. Key. TikTokEntryActivity. The token that bears the authorization of the TikTok user, which is obtained through /v2/oauth/token/ TikTok API for Business is a series of interface services provided by TikTok for Business to developers. Developers worldwide can apply for access to the API and portability will be available for TikTok users in the European Economic Area (EEA). After successfully completing authentication with TikTok, your application will be able to request access to basic user data I have a developer account with TikTok. Obtain the client_key and client_secret located in the Credentials section of your app page on the TikTok for Developers website. Obtain the client_key and client_secret located in Overview. Created based on feedback from our partners, our new API follows industry standards including OAuth 2. playlist_id. The target TikTok user must have authorized your app for the video. Log in using your TikTok developer account. Configure redirect URI Key. Follow these Register your app with the TikTok for Developers website. Example. Post Info Object. basic and video. Integrating with our Login Kit enables users to quickly and securely sign into your app with their TikTok account. list scopes for your app; A TikTok account with a few posted Build awesome experiences and powerful tools that inspire creativity and allow users to create, connect, and share with the world. 0 for user authorization and API authentication. For more information about how to set up a webhook subscription, see Webhooks Overview. Developers sign in with their TikTok for Developers account, create or join an organization for their company, department, or group, and then cooperate on their project. The app name should match the app or website name and not describe your app. Through integrating and calling the TikTok API for Business interface, developers can leverage our interface to interact with TikTok Ads Manager, TikTok Accounts and TikTok Creator Marketplace functionalities. The date range during which the ads were published. Sign up for a developer account on the TikTok for Developers website. Query TikTok TikTok API for Business is a series of interface services provided by TikTok for Business to developers. It can be used to refresh the given videos' cover image url TTL. ; On the app page, switch the toggle next to your app's name to Production. Introducing TikTok Research API Wrappers on GitHub. basic allows access to APIs and data related to the basic user of a TikTok user. single scope, Add Data Request can only be called once to create a new request. activity. ; The target TikTok user must have authorized your app for the video. Given an authorized user and a list of video IDs, the /v2/video/query/ endpoint verifies that the videos belong to the user and returns video details. If response. Indicate the original media type of the resource. Webhook Events. For example, Nike Training Club uses the API to create in-app fitness challenges linked to TikTok API for Business is a series of interface services provided by TikTok for Business to developers. Configure redirect URI Every TikTok for Developer API requires a scope to be accessed, and sensitive fields are protected by additional scopes. We're launching our official TikTok for Developers YouTube channel for our community to explore TikTok's tools, APIs, and developer insights, Community. DEFAULT: The default share format. iOS. Before you can share to TikTok from your App, make sure you have obtained a Client Key from TikTok and installed the TikTok SDK to your Android project. The value should be Bearer. true You will hear back from us 1-2 weeks after submitting the application. Upload draft to TikTok. List items are sourced from TikTok Shop, giving users a delightful pathway to explore and purchase products right inside the TikTok app! TikTok API for Business is a series of interface services provided by TikTok for Business to developers. playlist_item_total. true. Mobile SDK. ; If you have a version of the app that has been approved and is live, you can revert back to that configuration by clicking Revert to Live version in the Import dropdown. Follow these steps to add your app to TikTok for Developers. For example, the scope user. The height of We're launching our official TikTok for Developers YouTube channel for our community to explore TikTok's tools, APIs, and developer insights, including exclusive content from TikTok DevDay. 0 and provides an improved integration experience. The access token and open ID of the TikTok user who authorized your app. ; The access token and open ID of the TikTok user who authorized your app. cursor. TikTok API limits the number of requests you can send in a given timeframe. list<CommercialContent> The list of commercial contents. Data Portability Application Guidelines. The description that the creator has set for the TikTok video. username. If we need any Key. See Product Info Object below for a full list of values. You can pass in a customized timestamp to fetch the user's videos posted before the provided timestamp. There are several official TikTok’s APIs which provide developers with tools to integrate TikTok functionalities into their applications and access TikTok data. 6. info. ; For cases where multiple portability. The permissions are granted on a scope level. com under Manage apps. As developers, you can help us inspire creativity and bring joy by providing awesome experiences for TikTok users. The cURL command below shows an example of how you can query the TikTok ads created in Italy between As part of our ongoing efforts to support data portability, the principles of market contestability, as well as provide users with more choice and control over their data, we're excited to announce our Data Portability API. Query TikTok Shop Products. Int64. Example curl --location DIRECT POST: Directly post the content to TikTok user's account. user. The token that bears the authorization of the TikTok user, which is obtained through /v2/oauth/token/ We will use the Display APIs to display a TikTok user's profile and videos on your platform. "min" needs to be after October 1st, 2022. list<Condition> The or conditions specify that at least one of the conditions in the list must be met. 5 or Key. ; For any portability. Required Actions TikTok Finds: Socializing online shopping. Programmatically, you may convert a TikTok's video URL into embedded video markup by using the oEmbed API. One example is secure multiparty computation (MPC), We're launching our official TikTok for Developers YouTube channel for our community to explore TikTok's tools, APIs, and developer insights, including exclusive content from TikTok DevDay. DIRECT POST: Directly post the content to TikTok user's account. Query Videos. 0 and above use FileProvider to share. See Review Info Object below for a full list of values. tiktokapi. basic. Learn Creator Marketplace API: Enable influencer marketing platforms and developers to easily and programmatically create boosted TikToks from creator content. Server API. Create a TikTok developer account from our signup page using your email. Our runner-up submission, TikTok Finds, provides users the ability to create and customize their own shopping lists in TikTok and seek inspiration from others' wishlists. This page provides guidelines for you to better understand our integration processes and requirements. Click to download Support share feature for TikTok 16. The longest video a developer can send via the initialize Upload Video endpoint is 10 minutes. Developers can build functions Create a TikTok developer account from our signup page using your email. Learn more about scopes. Research API Usage FAQs Obtain a client key and client secret by logging in to Developer Portal and selecting your app. The TikTok Developers API makes it easy to integrate TikTok features directly into third-party apps, websites, and tools. ; Format. For example, if a partner has X number of clients, it will get X number of open_id for the same TikTok user, but one persistent union_id for the particular user. Get started. The TikTok User Info and Video Posts API is an essential tool for developers looking to integrate user information and video content from the popular TikTok platform into their applications. Connect your app . The name should not include a reference to social media companies (for example, "TikTok app"). ; Your app must be approved for the video. has_more. Obtain a client key and client secret by logging in to Developer Portal and selecting your app. not. Query TikTok Shop Info. LoginKit is available on iOS, Android, Desktop and Web. See Video Object below for a full list of values. cursor to the next request will yield the results for the next page. duration. The "min" value should represent a date after October 1, 2022. Integration Add this access token in the authorization header of the http requests to connect to the Commercial Content API endpoints. The maximum number of accounts the user follows returned in a single response. Send the video to TikTok servers (not needed if transfer method is PULL_FROM_URL). Through our Research API, academic researchers from non-profit universities in the U. open_id. App review process Key. The music ID of the video. Obtain a client key and client secret by logging into the TikTok for Developers website. Follow for more coding videos. Organizations allow developers to collaborate as a group. There is a migration plan related to this API. Prerequisites Register your app. Learn more on Scopes Overview . The expiration for the access_token in seconds. These stages are meant to protect user privacy and help organize your data analysis. Consider a worst case scenario with 3 runners, and for example a large Jest test suite that takes 3 minutes to produce a failing result: Job extra1 acquires the We're launching our official TikTok Every TikTok for Developer API requires a scope to be accessed, and sensitive fields are protected by additional scopes. By leveraging this API, you can seamlessly retrieve a user's profile details, such as their username, profile picture, and bio, alongside accessing their video posts. Then go to the Manage apps page and select your app. Field names for desired data to be returned. Rate Limits. Access to additional user data requires approval from TikTok for Developers website. MEDIA_UPLOAD: Upload content to TikTok for users to complete the post using TikTok's editing flow. The time range during which the commercial contents were published. VCE Reference. It is possible that the API returns less videos than the max count due to reasons such as videos deleted/marked as private Webhook Events. In this example, when a visitor clicks the profile_deep_link, they will be redirected to the creator's profile page For example, if a server runs out of memory, a script can automatically restart it. It can be used to refresh the given videos' cover image URL TTL. Once authenticated users authorize your app, you can access their basic TikTok profile data including their display name and avatar. int32. You will need access to: A TikTok developer account on TikTok Developer Portal; Approval for both a Login Kit and TikTok API products; Granted user. list<Condition> The and conditions specify that all the conditions in the list must be met. When you are ready to submit your TikTok API for Business is a series of interface services provided by TikTok for Business to developers. This section demonstrates how to successfully upload videos or photos to TikTok for the user to review and post. The following are some example scopes: user. Learn more here. TikTok's Content Posting API now supports Photos! Developers can now integrate with the new API endpoints to allow creators post photos to their TikTok account directly from your app Most endpoints provided by TikTok for Developers require direct consent from TikTok users before you can invoke them. Content Posting API. The post information. You can view your approved research projects here. avatar_url. Design Guidelines. This step is highly recommended but not required. Users have the rights to only agree to a subset of scopes you requested from them. When rendering the Export to TikTok page, your app must invoke the API and use the latest creator information returned to display the account's available privacy level options and video/photo interaction settings. Login Kit is based on OAuth 2. Navigate to the Products section of your app page and click Add Refer to MainActivity in the demo-auth package as an example. You can now learn about our developer products and interesting stories from the tech teams that build TikTok. access_token. Create a new app, add the required details, and submit it for review. Max length: 150. height. Check out TikTok's new Research API Wrappers, which make it easier for researchers of all technical skill levels to use TikTok's Research 10. After successfully completing authentication with TikTok, developers can obtain an access_token for the TikTok user. The VCE will return random sample data based on your query, limited to 5,000 records per day. The height of Explain how your app utilizes the TikTok for Developers APIs, for example: "We would like to enable users to quickly and securely sign into our app with their TikTok account" "We would like to add a "Share to TikTok" button to our app so our users can share their videos to TikTok" How can I track the status of my application? This guide will show you how to use the Research API. apply_time. TikTok video from Tom Shaw (@tom. Query Videos Overview. Type . int64 . publish scope. If your application does not meet the criteria below, you may be required to resubmit your application or be requested to provide more details, which may delay your application's review. and. If it is expired, then re-invoke the get_qrcode API. At TikTok, we strive to encourage innovation, so we're launching this channel to grow resources for our community. TikTok API for Business is a series of interface services provided by TikTok for Business to developers. In this blog post, we'll give you an overview of TikTok for Developers and show you how to get started building apps using the TikTok API and SDK. If you're a researcher interested in using TikTok Research API, check out our documentation and explore the examples included inside the TikTok Research Key. Create research account After ensuring your eligibility, create a TikTok for Developers account using your professional email address All TikTok creators can post 3-minute videos, while some have access to post 5-minute or 10-minute videos. list<Condition> The not conditions specify that none of the conditions in the list must be met. Required. We recommend that developers targeting Android 7. It is possible that the API returns less comments than the max count due to reasons such as We are excited that you are seeking to integrate your app with TikTok. single and portability. We are excited that you are seeking to integrate your app with TikTok. Then obtain a client key and secret from the developer portal on https://developers. We will use the Display APIs to display a TikTok user's profile and videos on your platform. For example, if a partner has X number of clients, Whether TikTok has provided a verified badge to the account after confirming that it belongs to the user it represents. Android. Product. The username as the unique identifier "test_username" Yes . No. May 12, 2023: All new apps registered on TikTok for Developers must use v2 OAuth APIs. For details on these requirements, see Getting started. November 3, 2023. 8978345345214861235. single are authorized by This API returns profile and permission information of the current user. 123451234512345. ad_published_date_range. No This guide will show you how to use the Research API. mycoolapp. Get approval and authorization of the video. The following example demonstrates how to use the TikTokEntryActivity to receive the We're launching our official TikTok for Developers YouTube channel for our community to explore TikTok's tools, APIs, and developer insights, including exclusive content from TikTok DevDay. Type. What is TikTok API? API refers to Application Program Interface that helps developers leverage each other application’s data and functionality through a documented interface. tiktok. The request_id for which the status is requested. To directly post a video to users' TikTok accounts, you must invoke the Content Posting API - Direct Post endpoint to perform the following actions: Query creator information to render the UI elements to be displayed on the Export page of your app. com. Developer Guidelines. basic gives read-only access to a user's avatar and display Developer Guidelines. The VCE allows you to access and analyze TikTok's public data in two stages. ; Click Draft in the left navigation panel. ; Build share content for images and videos into the MediaContent model. The generated client access token. Instead of waking up at 2 AM, We're launching our official TikTok for Developers YouTube channel for our community to explore TikTok's tools, APIs, and developer insights, This guide details how to enable authentication from your desktop app to TikTok. ; Click Import, then select the sandbox you want to import from. upload scope. By default, you are subscribed to all events when a callback URL is configured in the TikTok Developer Portal. 3K Likes, 70 Comments. list. Android Quickstart. and Europe can apply to study public data about TikTok content and accounts. Example response The VCE allows you to access and analyze TikTok's public data in two stages. Note that the website behaves differently on Mobile and Desktop devices. Create or join an organization representing the owning group of the app. Number of video ids should not be larger than 20 at Example Use Cases Display User's TikTok Profile. Before proceeding, make sure you complete all of the steps in the iOS Quickstart. ; February 29, 2024: End of life for v1 OAuth API, for web apps only. Description. single scopes are authorized by the user:; Example: If scopes portability. tiktokapis. Using organizations, multiple developers can work together on registered apps in TikTok for Developers. content_published_date_range. 20. As the platform’s reach expands, so does the demand for data and insights. TikTok provides an open API to developers There are several official TikTok’s APIs which provide developers with tools to integrate TikTok functionalities into their applications and access TikTok data. See User Info Object below for a full list of values. Integration Essentials. A complete access sample demo project, you can visually view the access method and API usage through Demo, test Demo uses the test Client Key for reference only. fields. Can I start using Research Tools? Your developer account alone is not sufficient to grant you access to Research Tools. developer): “Learn how to automatically generate example data in Postman for API testing, making your testing process more efficient and hassle-free. Perfect for testing REST APIs! #programming #coding #webdevelopment”. Size restrictions Notes: If "all_data" is sent as a parameter in category_selection_list, it will take precedence over other categories. Obtain the client_key located in the App details section of your app on the TikTok for Developers website. ; June 12, 2023: Developers will no longer be able to add or modify redirect domains in their Login Kit configurations for web apps. "application/json" Yes. Content Posting API; Research API; Display API; Embed Videos; Data Portability API Key. Register your app following these steps. string To directly post a video to users' TikTok accounts, you must invoke the Content Posting API - Direct Post endpoint to perform the following actions: Query creator information to render the UI elements to be displayed on the Export page of your app. Upload Overview. Before You Start. Discover the various types of data that can be generated and how to incorporate them into your API requests. The maximum number of followers that can be returned in this response. list scopes for your app; A TikTok account with a few posted Query TikTok Shop Info. The unique ID of the playlist. Query TikTok Shop Reviews. For more details, please refer to the document. User's profile image. The app name must adhere to the TikTok Brand and Use Guidelines. Use the /v2/video/list/ and /v2/video/query/ APIs to get the metadata of a TikTok user's videos and integrate an embedded video player into your product. No TikTok API for Business is a series of interface services provided by TikTok for Business to developers. The username as the unique identifier of the video creator "region_code" string. Then add Share Kit to your app by navigating to the Manage apps page, and clicking + Add products . expires_in. post_info. Content Posting APIs are compatible with desktop, cloud, and web applications. TikTok users may trim developer-sent videos inside the TikTok app to fit their accounts' actual maximum publish durations. Refer to the We provide two ways for you to receive the callback data from TikTok: For example, com. The unique identification of the user across different apps for the same developer. iOS Quickstart. Content-Type. developer): “Generate example data for your projects with Jason Generator, a free tool for developers to define data structures quickly and easily. video. We’re excited to announce the official TikTok for Developers YouTube channel, a new space for you to learn about TikTok's latest technologies and beyond. Learn more about the UX guidelines here. Learn more about the creator_info/query API here. Test Stage: Query the data using TikTok's query software development kit (SDK). Security advisory: Verifying integrity using client_ticket. It is possible that the API returns less comments than the max count due to reasons such as Key. Limits for each API are set and enforced separately. Provides the total number of items in a playlist. basic gives read-only access to a user's please refer to the legacy user access token management API guide. Additionally, you can provide different posting options in your app by letting creators either post their content directly from your app to their TikTok profile or upload it to TikTok as a draft for further editing. A shareable link for this TikTok video. Content Sharing Guidelines. If your application is approved, then you can login to TikTok for Developers account and find the client key required for accessing the Commercial APIs. The duration of the TikTok video in seconds. The token that bears the authorization of the TikTok user, which is obtained through /v2/oauth/token/. avatar_url_100. A comma-separated list (,) of the scopes the user has agreed to authorize. Our new API is hosted at open. For example, do not add "Video Content Analytics Uploader" as the name. Products. TikTok webhooks are sent with a signature the destination server can use to verify that the event came from TikTok and not a third party or malicious system. TikTok for Developers offers a wide variety of features that developers can add to their apps: Login Kit, Check out TikTok's new Research API Wrappers, which make it easier for researchers of all technical skill levels to use TikTok's Research API. Cursor for pagination. Default limits are provided below Send a share request. String. "tiktok" music_id. Check out TikTok's new Research API Wrappers, which make it easier for researchers of all technical skill levels to use TikTok's Research We're launching our official TikTok for Developers YouTube channel for our community to explore TikTok's tools, APIs, and developer insights, including exclusive content from TikTok DevDay. int64. or. Authorization. The following example demonstrates how to use the TikTokEntryActivity to receive the Access to additional user data requires approval from TikTok for Developers website. all. DateRange. bool. Login Kit. Users will receive an inbox notification. Community. . It is a comma separated list. Cobuilds bring new requirements, however. To upload a video without posting it, you must invoke the Content Posting API to do the following: Initialize the video upload. Upon approval, you will be provided Migrating to our new API. Learn how to use the Research API to query video data and fetch public TikTok account data in the following use case example. Example Value. playlist_last_updated More than 500 research teams use TikTok's Research Tools today. API calls to old endpoints will be rejected. commercial_contents. It is possible that the API returns less videos than the max count due to reasons such as videos deleted/marked as private by users etc. The flag that indicates if there are more items to be returned. S. ”. true Example. You can use the shareFormat field in the share request object to share images or videos with TikTok in different formats. fpjljajrlwgzzeplnhdthocjqfuzsgasruplgsayzjdtvhrjk