사이드 메뉴
Getting started
Kakao Developers
Login
Communication
Advertisement
- Concepts
- Ad creation: Ad account
- Ad creation: Campaign
- Ad creation: Ad group
- Targeting for ad group
- Custom audience targeting for ad group
- Ad creation: Creative common
- Ad creation: Display creative
- Ad creation: Message creative
- Ad creation: Personalized message creative
- Bizboard landing settings
- Report
- Message management
- Personalized message management
- Message ad management
- Message ad operation
- Ad View management
- Business Form+ management
- Business Form linkage management
- Pixel & SDK linkage management
- Audience management
- Engagement targeting management
- Customer file management
- Friend group management
- Ad account management
- Reference
- Type information
- Error code
Documentation
Glossary
This document explains the terms mentioned in the Kakao Developers documentation.
- Terms are sorted in alphabetical order.
A • B • C • D • E • F • G • H • I • J • K • L • M • N • O • P • Q • R • S • T • U • V • W • X • Y • Z
| Term | Description |
|---|---|
| Access token | One of the tokens used for authorization through the OAuth 2.0 protocol. The access token delegates authority to access resources or make an API call on behalf of a user. You do not have to go through the authorization process after the initial authorization until the access token expires. To see the expiration time, refer to Token information. |
| Admin key | One of the app keys used for authorization for an app's administrator. You need to use an Admin key to use the functions that handle important information or may cause serious problems in your app, such as the Retrieve user list API. Keep the Admin key confidential in storage. |
| API | Abbreviation of 'Application Programming Interface'. Clients can use the services provided by Kakao by calling the Kakao APIs through an HTTP protocol. |
| App | An app is a project unit for managing service information registered on the Kakao Developers. It does not refer to the commonly used term 'mobile app,' but rather to the service information registered on Kakao Developers. It is used to register part of the service information on the Kakao platform in order to obtain authorization to call Kakao APIs, and it has an ID and key used to determine whether Kakao API requests are authorized. |
| App ID | Refers to an identifier used to identify applications. App ID is assigned for each app when you register an app. To check your app IDs, see the All applications list or the Basic Information section on the app management page. Leaving your app ID when you ask questions in DevTalk helps you to get quick answers. |
| App key | An app key is a unique identification key issued to use APIs of the Kakao platform. For the terminology, see Platform key / Admin key. |
| App user ID | See Service user ID. |
| Application | Software developed to provide a service or a specific feature, allowing users to access APIs or utilize various services through the application. Typically, it can run in a variety of environments, such as web, mobile, or desktop, and can exchange data with external systems by calling APIs. |
| Authentication | Refers to a process to verify a user's credential. It focuses on who the person is for identification. |
| Authorization | Refers to a function to grant access or usage permission to the verified users or apps. Only the authorized users or apps can use the Kakao APIs. |
| Authorization code | Refers to a temporary code consisting of numbers and alphabets used to check a user's credential based on OAuth 2.0 authorization system. This code is issued from the Kakao server when a user consents on the Consent screen during login and used to exchange for an access token. Only after an authorization code is issued, you can obtain the tokens. |
| Auto-login | Enables users to log in automatically from Kakao Talk in-app browser, and shows a different page depending on the user's login status. |
| Term | Description |
|---|---|
| Biz app | Refers to an app with business operator information registered. Only Biz apps can use Kakao Sync and specific APIs, such as the Retrieve a list of Kakao Talk friends API and the Kakao Talk Message API. When you switch your app to a Biz app, you can set some consent items to 'Required consent' without any review process or use exclusive features. Refer to Biz app for more details. |
| Biz channel app | An app that is linked to a Business Channel with the same business operator information registered in the Biz app. |
| Business Channel | Refers to a Kakao Talk Channel with business operator information registered. You can create a new Kakao Talk Channel and switch your Kakao Talk Channel to a Business Channel in Kakao Talk Channel Partner Center. Only after switching to a Business Channel, the option to add a Kakao Talk Channel is displayed in the Simple Signup Consent screen. |
| Term | Description |
|---|---|
| Callback | The 'Callback' feature has been renamed to 'Webhook'. See Webhook. |
| CI (Connecting Information) | Refers to an encoded identifier to identify users. CI is only used to check if the same user has already been registered in a service app. Refer to Personal information consent items for details. |
| CLI | Abbreviation of 'Command Line Interface'. A text-based interface that allows you to interact with a computer by typing commands in a program such as Terminal (Mac) or Command Prompt (Windows). Unlike a GUI (Graphical User Interface), it enables fast keyboard-only operations, so developers frequently use it. |
| Component | Each element that composes a message template, such as a button, link, message title and content, or image. Each component can be configured independently and combined to suit the purpose of a message. |
| Consent item | Refers to user information (scope) that requires consent to providing personal information to a third-party service. Users can consent to each consent item in the Consent screen presented when a user attempts to log in. |
| Creative | Refers to an advertisement displayed in a digital environment such as a website or an app. Image and video files used for banner ads, and the message body used to send messages, are examples of creatives. |
| curl | curl is a free, open-source command-line tool that uses URLs to transfer data. After you install curl, you can communicate with servers and transfer data over various protocols. If an API supports REST, you can easily execute REST API requests with curl commands. The request samples in the Kakao Developers REST API documentation use curl. |
| Custom parameter | Refers to a parameter added to a Custom URL Scheme in a key-value format to transmit information required for a service's needs. You can use a custom parameter to direct a user to a specific post in an app or to set an initial value. For example, if you pass a key and value as a parameter in androidExecutionParams = mapOf("key1" to "value1") format, the Custom URL Scheme in kakao${YOUR_NATIVE_APP_KEY}://kakaolink?key1=value1 format is called. |
| Custom template | A message template that you can customize to suit your service based on the default templates. You can easily create and edit custom templates in [Tools] > [Message Template] on Kakao Developers. |
| Custom URL Scheme | Refers to a specially formatted URI scheme that opens a specific app or web page. To use Kakao services, you need to set the Custom URL Scheme in kakao${YOUR_NATIVE_APP_KEY} format. To implement Kakao Login, use kakao${YOUR_NATIVE_APP_KEY}://oauth that allows accessing a redirect URI to receive an authorization code. To launch an external web page or app from a Kakao Talk message, use kakao${YOUR_NATIVE_APP_KEY}://kakaolink. |
| Customer file | Refers to a file that includes customer information so that you can group the receiving users to whom a Kakao Talk message is sent. You can upload this file in the Kakao Talk Channel Partner Center or request an API to register or manage customers. |
| Term | Description |
|---|---|
| Default template | Refers to the frequently used message formats provided as templates so that a service can send messages easily. Five types of templates are available: Feed, List, Location, Commerce, and Text. |
| Developer account | A developer account is the Kakao Account registered on Kakao Developers as Kakao API user through sign-up. You can easily create a developer account by logging in with a Kakao Account, entering a developer name, and agreeing to the Service terms. |
| Term | Description |
|---|---|
| Editor | One of the roles designated in an app by registering as team member on the Kakao Developers. Developers with the Editor account can view or modify the app information. |
| Event | Refers to a change in a user's status, such as linking or unlinking an app, changing the password, or deactivating the Kakao Account, or a user's action, such as unlinking or adding and blocking a Kakao Talk Channel. |
| Term | Description |
|---|---|
| Features requiring access permissions | The features can only be used in the service to get the Scopes by Authorization. A permission is required to set scopes in the service app. For the full list and details of features requiring access permissions, refer to the Scope of access permissions. |
| Field | An individual item that composes a data structure such as an API response. The elements of a response body or an object are referred to as fields, distinguished from parameters, which are input values of a request. Refer to the Notation guide for how to read the field tables of each API. |
| Friend | Refers to the user added on Kakao Talk. In the case of Kakao Talk Channel, a user who has added the Kakao Talk Channel is referred to as a 'Friend'. |
| Term | Description |
|---|---|
| Group of friends | Used to group customers (Kakao Talk Channel friends) and to send customized messages to the targeted groups. You can create a group of friends based on the users' additional information registered in the customer file, such as the region, gender, age, membership grade. You can also input users' phone numbers in person to create a group. |
| Term | Description |
|---|---|
| Header parameter | Refers to a parameter included in the request header, mainly used to pass authorization information. |
| Hybrid app | Refers to an app that combines a native platform app (Android or iOS) with mobile web content: the native app loads the content developed for the mobile web. A hybrid app has the advantages of both web and app, and can reduce the development period compared to building a separate native app for each platform. |
| Term | Description |
|---|---|
| IDE | Stands for Integrated Development Environment, a unified development environment that helps you write, run, and debug source code all in one place. Examples include Visual Studio Code, IntelliJ, Eclipse, and Cursor. IDEs provide features such as code auto-completion, syntax checking, and run buttons to make development easier and faster. |
| Term | Description |
|---|---|
| JSON | Abbreviation of 'JavaScript Object Notation'. Readable data format consisting of key-value pairs ("key": "value") to present data to be transferred or stored through API request and response. Most responses of Kakao APIs called through the JavaScript SDK and the REST API are returned in JSON format. |
| Term | Description |
|---|---|
| Kakao API | Open APIs or platform services provided by Kakao. Kakao APIs let you access a variety of features and data from services. See Kakao Developers products for the supported APIs. For the supported platform, see Scope of support. |
| Kakao Developers | Official name of the Kakao Developers website. It provides introduction to Kakao platform services, documentation, and various tools to help you to develop or test your app. You can manage or test apps, or download resources and SDKs. You can also leave feedback or questions in [Forum]. |
| Kakao Developers products | Refers collectively to the various APIs and SDKs provided by Kakao Developers. These enable developers to integrate core Kakao platform features, such as Kakao Login, Kakao Talk Share, Kakao Talk Message, and Kakao Map, into their own services. Details about the features and usage of each product can be found in the Concepts document for the respective product. |
| Kakao for Business | Refers to the Business platform where you can apply for business-related services and manage business information with a single Kakao Account. You can use Kakao Sync, Kakao Moment, Kakao Keyword Ad, and Kakao Talk Channel on this platform. |
| Kakao Talk Channel Partner Center | Refers to the Kakao Talk Channel Partner Center where you can create a Kakao Talk Channel and switch your Kakao Talk Channel to a Business Channel. You can send a targeted message to the predefined group of friends. |
| Term | Description |
|---|---|
| Link | Refers to a state or relationship indicating a user is connected to a service app. When a user logs in to a service with the Kakao Account, the user is linked with the service. Ensure that you must implement a process to complete a sign-up in your service because the link is not the same as a sign-up. |
| Term | Description |
|---|---|
| OAuth 2.0 | Refers to the authorization framework used on the Kakao platform. OAuth validates the user's credentials and delegates authority to access resources through an access token. OAuth 2.0 allows users to log in to a service with their Kakao Accounts. |
| OIDC | Abbreviation of OpenID Connect. An authentication standard based on OAuth 2.0 that also provides user identity information as an ID token during login. To use OIDC with Kakao Login, enable OpenID Connect. |
| Open API | Refers to the APIs provided to anyone who registers an app on the Kakao platform. You can use the open APIs for free under the quota. |
| Open Graph Protocol | A metadata standard that allows a web page to deliver structured content information, such as the title, description, image, and URL, when the page is shared on social media or messengers. Kakao Talk Share and Kakao Talk Message use this protocol to display web page information in a message. Refer to The Open Graph protocol for the specification. |
| Owner | Refers to the account that owns an app registered on Kakao Developers. The Owner account has all authorities for the app. Usually, the one who creates an app is the owner, but sometimes one of the team members can be the owner. |
| Term | Description |
|---|---|
| Parameter | An input value passed in an API request. Depending on where it is passed, it is classified as a query parameter, path variable, or body parameter. The elements of a response are referred to as fields instead of parameters. Refer to the Notation guide for how to read the parameter tables of each API. |
| Partner | Refers to a service in a partnership using the Kakao platform. To increase the maximum quota amount for your app or a specific API, or to use a specific service such as Kakao Sync, a partnership arrangement is required. Refer to [Concepts] of each service documentation. |
| Permalink | Refers to a bridge URL that redirects users to a specified URL. This is used for a service that applies Kakao Sync. Permalink launches the Kakao Talk app and opens your service page through in-app view when they scan a QR code through Kakao Talk or other apps. Users do not need to log in with their Kakao Account because the Kakao Talk Account information stored on their devices where Kakao Talk is installed is used. To request Kakao Sync Permalink, visit DevTalk or contact the Kakao Sync Customer Center. |
| Permission | Refers to authority to access user information to use specific functions or APIs. Before using the API, check [Prerequisites] of the service first and request the required permission. |
| Platform key / Admin key | Platform keys and the Admin key are unique keys issued to identify and authenticate a service app when requesting Kakao API. When you create an app, platform keys such as the REST API key, JavaScript key, and Native app key, along with the Admin key, are issued together, and each key is used according to the calling method and execution environment (Web, Native app, Server). Platform keys are used for SDK initialization and general API calls, and the Admin key is used only on the server when calling APIs that require sensitive configuration changes or administrator permissions. For details, see Platform key / Admin key. |
| Term | Description |
|---|---|
| Query parameter | Used to pass additional information to a server when you call an API in parameter=value format after a question mark(?). When you pass multiple parameters, separate them with an ampersand(&).For example, in https://kauth.kakao.com/oauth/authorize?response_type=code&client_id=${REST_API_KEY}, response_type=code&client_id=${REST_API_KEY} is a query parameter specifying response_type as the parameter name and code as the parameter value. |
| Term | Description |
|---|---|
| Redirect URI | Refers to the path to which a user's web browser is redirected after the user completes Kakao Login and consent. The Kakao authorization server passes an authorization code to the redirect URI, so the redirect URI must be registered on Kakao Developers in advance. Refer to Redirect URI for the configuration. |
| REST API | Abbreviation of 'Representational State Transfer Application Programming Interface'. It refers to an architecture that defines how to create (POST), retrieve (GET), modify (PUT), or delete (DELETE) resources based on HTTP. REST API indicates the APIs implemented based on REST. |
| Term | Description |
|---|---|
| Schema | Usually refers to a blueprint that defines how to construct data in the database management system, such as structure or expression. For the APIs related to the Kakao Talk Channel customer management function, schema indicates the predefined rules about the input format available in the customer file, such as the data name and data type. You can register only the data that complies with the schema in the customer file. Refer to a notice in Kakao Talk Channel Partner Center for the schema. |
| SDK | Abbreviation of 'Software Development Kit'. It refers to a package that contains the tools required to develop the Kakao services. The Kakao SDK also provides a sample app so that developers can easily develop an app or web using the Kakao platform service. The Kakao SDK supports Android, iOS, and JavaScript, and you can download the Kakao SDK in the SDK Download menu. |
| Service | Refers to a product that a third-party owns or operates, usually a form of a website, app, or else. |
| Service terms | Any kind of terms required for the operation of a service, which are registered and managed directly by the service. Types of Service terms include Terms of Use, Privacy Policy, 14+ Age Agreement, and Electronic Financial Transaction Terms. |
| Service user ID | Refers to a unique identifier used to identify users in a service. The Service user ID is issued per app when a user selects [Accept and Continue] in the Consent screen. Thus, even the same user can have different Service user IDs in other apps. To figure out a user's Service user ID, call the Retrieve user information API and check id. |
| Share debugger | See Manage Kakao Talk URL metadata. |
| SET | Abbreviation of 'Security Event Token'. Information delivered to the webhook URL set by the service when a Kakao Account status change event occurs. To deliver event information securely, it is passed in JSON Web Token (JWT) format in accordance with the Security Event Token (SET) specification of the OpenID Foundation. Refer to SET information for details. |
| Simple login | Enable users to simply log in through Kakao Talk without inputting Kakao Account information, which is provided by the Kakao SDK for JavaScript. |
| Simple Signup Consent screen | Refers to the screen presented when a user attempts to log in for the first time in an app that applies Kakao Sync. Unlike the general Kakao Login Consent screen, the Simple Signup screen includes the Terms of Use and an option to add a Kakao Talk Channel. |
| Term | Description |
|---|---|
| Token | Refers collectively to the access token and refresh token issued when a user logs in. A token verifies a user's identity, allowing the user to keep using Kakao APIs without additional verification while the token is valid. |
| Term | Description |
|---|---|
| Universal Link | Refers to a standard web link that points to either a web page or the content in an app, depending on whether the app is installed or not. If an app is installed on a user's device, the user is redirected to the app when clicking the Universal Link. If not installed, Safari is open to show the content. Universal links are only supported in iOS 9 or higher. |
| Unix Timestamp | A numeric value that represents the elapsed time in seconds or milliseconds since January 1, 1970, 00:00:00 UTC (Coordinated Universal Time). Unix timestamps are commonly used to express time data in a consistent manner in systems, timestamps, or APIs. |
| URI | Abbreviation of Uniform Resource Identifier. A string that identifies the location or name of a web resource. For Kakao Login, register the path where users are redirected after login and consent as a Redirect URI. |
| User | Refers to end-users who use the Kakao services implemented in the third-party service. |
| User argument | Used for variable information in a Kakao Talk message. Add a user argument when you configure a custom message template in [Tools] > [Message Template] on Kakao Developers, and then pass the value of the user argument when requesting to send a message through the Kakao Talk Share API or the Kakao Talk Message API. |
| UUID | Abbreviation of 'Universally Unique Identifier'. It refers to a unique identifier issued for each friend by app. To send a Kakao Talk message, you need to know the UUIDs of receiving users. Thus, call the Retrieve list of friends API first before sending a Kakao Talk message. |
| Term | Description |
|---|---|
| Webhook | A feature that allows your service to receive event information when a specific event occurs, such as unlinking, account status changes, and adding or blocking a Kakao Talk Channel. With this feature, you can respond to events that occur outside your service. Refer to Webhook for details. |
| Webhook URL | An endpoint to receive event information from Kakao when an event occurs, such as unlinking or account status changes. |