For the complete documentation index, see llms.txt. This page is also available as Markdown.

Toss 登录

获取 AccessToken

post

这是一个根据 Authorization Code 颁发 Access Token 和 Refresh Token 的 API。颁发的 Access Token 有效期为 1 小时。

业务错误代码

以下错误会以 HTTP 200 和 resultType: FAIL 响应。

errorCode
说明

4050

不是注册到认证服务器的迷你应用。

4095

请求已超出限制。请稍后再试。

此 API 可以原样传递所对接内部系统的错误代码。未文档化的 errorCode 会按失败处理,请参考 reason 消息。

请求限额: 每个应用每分钟 3,000 次

授权
mutualTLS

这是基于为合作伙伴签发的客户端证书的 mTLS 认证。通过证书的 CN 来识别迷你应用。证书签发·管理方法请参考 使用服务器 API 文档。

请求体

这是用于发放 OAuth2 token 的请求正文。

authorizationCodestring必填

这是通过 OAuth2 认证流程发放的 Authorization Code。此代码会在用户完成认证后作为查询参数传递到重定向 URL。

Example: SplxlOBeZQQYbYS6WxSbIA
referrerstring必填

这是用户进入应用的来源路径。例如,表示通过深度链接、推送通知、应用内横幅等哪种路径使用了该功能。

Example: deeplink
响应
200

请求成功,返回已颁发的令牌信息。

application/json
post/api-partner/v1/apps-in-toss/user/oauth2/generate-token
POST /api-partner/v1/apps-in-toss/user/oauth2/generate-token HTTP/1.1
Host: apps-in-toss-api.toss.im
Content-Type: application/json

{
  "authorizationCode": "SplxlOBeZQQYbYS6WxSbIA",
  "referrer": "deeplink"
}
{
  "resultType": "SUCCESS",
  "success": {
    "accessToken": "ya29.A0ARrdaM9bZxZJ...",
    "expiresIn": 3600,
    "refreshToken": "1//0gdfg23rF9sds...",
    "scope": "profile message:send",
    "tokenType": "Bearer"
  }
}

获取用户信息

get

这是一个使用 Access Token 查询已登录用户信息的 API。

业务错误代码

以下错误会以 HTTP 200 和 resultType: FAIL 响应。

errorCode
说明

4010

找不到认证信息。

4095

请求已超出限制。请稍后再试。

此 API 可以原样传递所对接内部系统的错误代码。未文档化的 errorCode 会按失败处理,请参考 reason 消息。

请求限额: 每个应用每分钟 3,000 次

授权
mutualTLS

这是基于为合作伙伴签发的客户端证书的 mTLS 认证。通过证书的 CN 来识别迷你应用。证书签发·管理方法请参考 使用服务器 API 文档。

头参数
Authorizationstring必填

这是包含 Bearer 形式 Access Token 的 Authorization 头值。Access Token 通过 获取 AccessToken API 颁发。

Example: Bearer ya29.A0ARrdaM9bZxZJ...
响应
200

请求成功,查询到的用户个人资料信息会作为响应返回。部分项目可能会根据用户同意情况而为 null

application/json
get/api-partner/v1/apps-in-toss/user/oauth2/login-me
GET /api-partner/v1/apps-in-toss/user/oauth2/login-me HTTP/1.1
Host: apps-in-toss-api.toss.im
Authorization: Bearer {accessToken}
{
  "resultType": "SUCCESS",
  "success": {
    "agreedTerms": [
      "tos_terms_1",
      "privacy_policy"
    ],
    "birthday": "19900101",
    "callingCode": "82",
    "ci": "aaf7cb53...",
    "di": "b712df83...",
    "email": "user@example.com",
    "gender": "M",
    "name": "홍길동",
    "nationality": "KR",
    "phone": "1012345678",
    "scope": "profile message:send",
    "userKey": 123456789
  }
}

重新获取 AccessToken

post

这是一个使用 Refresh Token 重新颁发 Access Token 的 API。Refresh Token 的有效期为 14 天。

业务错误代码

以下错误会以 HTTP 200 和 resultType: FAIL 响应。

errorCode
说明

4050

不是注册到认证服务器的迷你应用。

4095

请求已超出限制。请稍后再试。

此 API 可以原样传递所对接内部系统的错误代码。未文档化的 errorCode 会按失败处理,请参考 reason 消息。

请求限额: 每个应用每分钟 3,000 次

授权
mutualTLS

这是基于为合作伙伴签发的客户端证书的 mTLS 认证。通过证书的 CN 来识别迷你应用。证书签发·管理方法请参考 使用服务器 API 文档。

请求体

这是使用已签发的 refresh token 重新签发 access token 的请求。

refreshTokenstring必填

这是已签发的 refresh token。可使用该 token 请求新的 access token。

Example: 1//0gdfg23rF9sds...
响应
200

请求成功,返回重新颁发的 Access Token 相关信息。

application/json
post/api-partner/v1/apps-in-toss/user/oauth2/refresh-token
POST /api-partner/v1/apps-in-toss/user/oauth2/refresh-token HTTP/1.1
Host: apps-in-toss-api.toss.im
Content-Type: application/json

{
  "refreshToken": "1//0gdfg23rF9sds..."
}
{
  "resultType": "SUCCESS",
  "success": {
    "accessToken": "ya29.A0ARrdaM9bZxZJ...",
    "expiresIn": 3600,
    "refreshToken": "1//0gdfg23rF9sds...",
    "scope": "profile message:send",
    "tokenType": "Bearer"
  }
}

使用 AccessToken 解除登录连接

post

这是一个使用 Authorization 头中的 Access Token 解除该用户连接的 API。

业务错误代码

以下错误会以 HTTP 200 和 resultType: FAIL 响应。

errorCode
说明

4050

不是注册到认证服务器的迷你应用。

4010

找不到认证信息。

4095

请求已超出限制。请稍后再试。

此 API 可以原样传递所对接内部系统的错误代码。未文档化的 errorCode 会按失败处理,请参考 reason 消息。

请求限额: 每个应用每分钟 3,000 次

授权
mutualTLS

这是基于为合作伙伴签发的客户端证书的 mTLS 认证。通过证书的 CN 来识别迷你应用。证书签发·管理方法请参考 使用服务器 API 文档。

头参数
Authorizationstring必填

这是包含用户 Access Token 的 Authorization 头值。Access Token 通过 获取 AccessToken API 颁发。

Example: Bearer ya29.A0ARrdaM9bZxZJ...
响应
200

请求成功,已成功解除与 Access Token 对应用户的连接。

application/json
post/api-partner/v1/apps-in-toss/user/oauth2/access/remove-by-access-token
POST /api-partner/v1/apps-in-toss/user/oauth2/access/remove-by-access-token HTTP/1.1
Host: apps-in-toss-api.toss.im
Authorization: Bearer {accessToken}
{
  "resultType": "SUCCESS",
  "success": {
    "userKey": 123456789
  }
}

用 userKey 断开登录连接

post

这是一个使用 userKey 解除该用户登录连接的 API。响应中仅包含已解除连接的用户的 userKey

业务错误代码

下面的错误会以 HTTP 200 和 resultType: FAIL 响应。

errorCode
说明

4050

不是注册到认证服务器的迷你应用。

4095

请求已超出限制。请稍后再试。

此 API 可以原样传递所对接内部系统的错误代码。未文档化的 errorCode 会按失败处理,请参考 reason 消息。

请求限额: 每个应用每分钟 3,000 次

授权
mutualTLS

这是基于为合作伙伴签发的客户端证书的 mTLS 认证。通过证书的 CN 来识别迷你应用。证书签发·管理方法请参考 使用服务器 API 文档。

请求体

通过 UserKey 解除 OAuth2 用户连接请求

userKeyinteger · int64必填

这是要解除连接的用户唯一标识符。用于在内部系统中识别用户。

Example: 123456789
响应
200

请求成功,基于 userKey 已解除连接的用户的 userKey 返回。

application/json
post/api-partner/v1/apps-in-toss/user/oauth2/access/remove-by-user-key
POST /api-partner/v1/apps-in-toss/user/oauth2/access/remove-by-user-key HTTP/1.1
Host: apps-in-toss-api.toss.im
Content-Type: application/json

{
  "userKey": 123456789
}
{
  "resultType": "SUCCESS",
  "success": {
    "userKey": 123456789
  }
}

这有帮助吗?