> For the complete documentation index, see [llms.txt](https://developers-apps-in-toss.toss.im/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers-apps-in-toss.toss.im/documentation/api-and-sdk-zh/overview.md).

# API & SDK 一览

您可以在 App in Toss 中一站式查看提供的主要功能和相关文档。可按功能直接跳转到所需的 Client SDK 文档或服务器 API 文档。

[查看示例项目](https://github.com/toss/apps-in-toss-examples/tree/main)

{% hint style="info" %}
**请将 WebView 项目更新到 SDK 3.x。**

SDK 3.x 是对 WebView 项目结构进行优化的更新。配置文件名称和部分属性已变更，客户端 SDK 也整理为以领域对象为中心。

如果您正在运营 WebView 项目 [SDK 3.x 迁移](/documentation/api-and-sdk-zh/integration/sdk-3.x.md) 请查看文档。
{% endhint %}

| 功能                                                                         | 说明                                        |
| -------------------------------------------------------------------------- | ----------------------------------------- |
| [用户识别密钥发放](/documentation/api-and-sdk-zh/sdk/domains-api/user.md)          | 即使不登录，也可以获取可用于区分用户的匿名用户识别键。               |
| [用户识别键验证](https://developers-apps-in-toss.toss.im/api/user-key)            | 可以在服务器上验证通过 SDK 颁发的匿名用户识别键是否有效。           |
| [用户信息](/documentation/api-and-sdk-zh/sdk/domains-api/user.md)              | 可以查询用户同意提供的个人信息或年龄段信息。                    |
| [Toss 登录](/documentation/api-and-sdk-zh/sdk/domains-api/tossauth.md)       | 可以用 Toss 账号登录并获取授权码。                      |
| [Toss 登录 API](https://developers-apps-in-toss.toss.im/api/toss-login)      | 可以使用发放 AccessToken、查询用户信息、断开登录连接等服务器 API。 |
| [Toss 认证](/documentation/api-and-sdk-zh/sdk/domains-api/tossauth.md)       | 可以使用 Toss 证书签名或确认是否已与 Toss 登录联动的功能。       |
| [应用内支付](/documentation/api-and-sdk-zh/sdk/domains-api/iap.md)              | 可以进行 App Store 或 Play 商店内购。               |
| [应用内购 API](https://developers-apps-in-toss.toss.im/api/iap)                | 可以在服务器上查询应用内购订单状态。                        |
| [Toss Pay 支付认证](/documentation/api-and-sdk-zh/sdk/domains-api/toss-pay.md) | 可以拉起 Toss Pay 支付窗口，并进行一次性支付或定期支付认证。       |
| [Toss Pay API](https://developers-apps-in-toss.toss.im/api/toss-pay)       | 可以使用 Toss Pay 支付执行、状态查询、退款等服务器 API。       |
| [促销奖励](/documentation/api-and-sdk-zh/sdk/domains-api/promotion.md)         | 可以使用 Toss 积分奖励发放或好友邀请功能。                  |
| [促销 API](https://developers-apps-in-toss.toss.im/api/promotion)            | 可以使用 Toss 积分发放密钥生成和奖励发放执行 API。            |
| [推送、通知 API](https://developers-apps-in-toss.toss.im/api/push)              | 可以在服务器上发送测试消息、单条消息和批量消息。                  |
| [通知同意](/documentation/api-and-sdk-zh/sdk/domains-api/notification.md)      | 可以向用户请求接收通知同意。                            |
| [分享](/documentation/api-and-sdk-zh/sdk/domains-api/share.md)               | 可以创建 Toss 分享链接或拉起消息分享窗口。                  |
| [请求评价](/documentation/api-and-sdk-zh/sdk/domains-api/review.md)            | 可以在用户感到满意的时机请求撰写应用评价。                     |
| [广告](/documentation/api-and-sdk-zh/sdk/domains-api/ads.md)                 | 可以使用插页广告、激励广告、AdMob 广告等广告功能。              |
| [用户行为记录](/documentation/api-and-sdk-zh/sdk/domains-api/analytics.md)       | 可以记录点击、曝光、进入页面、用户行为事件。                    |
| [数据 SDK API](https://developers-apps-in-toss.toss.im/api/sdk)              | 可以查看数据 SDK 联动所需的服务器 API。                  |
| [安全区域](/documentation/api-and-sdk-zh/sdk/domains-api/safearea.md)          | 可以查询或订阅屏幕边距值，以免被刘海或圆角遮挡。                  |
| [屏幕控制](/documentation/api-and-sdk-zh/sdk/domains-api/screen.md)            | 可以控制关闭页面、设置方向、始终亮屏、防止截屏等行为。               |
| [设备](/documentation/api-and-sdk-zh/sdk/domains-api/device.md)              | 可以使用打开外部 URL、相机、相册、联系人、位置、触觉反馈等设备功能。      |
| [权限](/documentation/api-and-sdk-zh/sdk/domains-api/permissions.md)         | 可以检查或请求相机、位置、照片库、联系人、剪贴板等设备权限。            |
| [剪贴板](/documentation/api-and-sdk-zh/sdk/domains-api/clipboard.md)          | 可以获取剪贴板中保存的文本，或复制文本。                      |
| [文件](/documentation/api-and-sdk-zh/sdk/domains-api/file.md)                | 可以将 Base64 文件保存到设备，或用原生查看器打开 PDF 文件。      |
| [游戏](/documentation/api-and-sdk-zh/sdk/domains-api/game.md)                | 可以使用游戏中心排行榜、游戏资料、分数登记功能。                  |
| [存储](/documentation/api-and-sdk-zh/sdk/domains-api/storage.md)             | 可以将用户信息保存到设备并读取。                          |
| [环境](/documentation/api-and-sdk-zh/sdk/domains-api/environment.md)         | 可以查看运行环境、Toss App 版本、网络状态、服务器时间、语言等信息。    |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developers-apps-in-toss.toss.im/documentation/api-and-sdk-zh/overview.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.