获取有关授权令牌的信息

Info

Console

方法适用于模式：FBY, FBS, Express 和 DBS.

如果您使用API-Key令牌，调用该方法时需要具备列表中可用权限之一

inventory-and-order-processing — 订单处理和商品核算
inventory-and-order-processing:read-only — 查看订单信息
pricing — 价格管理
pricing:read-only — 查看价格
offers-and-cards-management — 商品和卡片管理
offers-and-cards-management:read-only — 查看商品和卡片
promotion — 商品推广
promotion:read-only — 查看商品推广信息
finance-and-accounting — 查看财务信息和报告
communication — 与买家沟通
settings-management — 店铺设置
supplies-management:read-only — 获取有关FBY应用程序的信息
all-methods — 全面管理账户
all-methods:read-only — 查看所有数据

该方法仅适用于 Api-Key-令牌。

返回有关传输的授权令牌的信息。

⚙️ 限制: 每小时100个请求

Request

POST

https://api.partner.market.yandex.ru/v2/auth/token

Responses

200 OK

授权令牌的信息。

Body

application/json

{
    "status": "OK",
    "result": {
        "apiKey": {
            "name": "string",
            "authScopes": [
                "ALL_METHODS"
            ]
        }
    }
}

Name

Description

result*

Type: TokenDTO

授权令牌的信息。

status*

Type: ApiResponseStatusType

响应的类型。可能的值:

OK — 没有错误。
ERROR — 处理请求时出错。

Enum: OK, ERROR

TokenDTO

授权令牌的信息。

Name

Description

apiKey*

Type: ApiKeyDTO

有关资料 Api-Key-令牌。

ApiResponseStatusType

响应的类型。可能的值:

OK — 没有错误。
ERROR — 处理请求时出错。

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

ApiKeyDTO

有关资料 Api-Key-令牌。

Name

Description

authScopes*

Type: ApiKeyScopeType[]

软件方法的访问 Api-Key-令牌。
方法的访问:

ALL_METHODS — 全柜管理。
ALL_METHODS_READ_ONLY — 查看机柜中的所有信息。
INVENTORY_AND_ORDER_PROCESSING — 货物的订单处理和核算。
INVENTORY_AND_ORDER_PROCESSING_READ_ONLY — 查看有关订单的信息。
PRICING — 价格管理。
PRICING_READ_ONLY — 查看价格。
OFFERS_AND_CARDS_MANAGEMENT — 商品和卡片的管理。
OFFERS_AND_CARDS_MANAGEMENT_READ_ONLY — 查看产品和卡片。
PROMOTION — 产品推广。
PROMOTION_READ_ONLY — 查看有关产品促销的信息。
FINANCE_AND_ACCOUNTING — 查看财务信息和报表。
COMMUNICATION — 与客户的沟通。
SETTINGS_MANAGEMENT — 设立商店。
SUPPLIES_MANAGEMENT_READ_ONLY — 获取有关 FBY-申请。

Enum: ALL_METHODS, ALL_METHODS_READ_ONLY, INVENTORY_AND_ORDER_PROCESSING, INVENTORY_AND_ORDER_PROCESSING_READ_ONLY, PRICING, PRICING_READ_ONLY, OFFERS_AND_CARDS_MANAGEMENT, OFFERS_AND_CARDS_MANAGEMENT_READ_ONLY, PROMOTION, PROMOTION_READ_ONLY, FINANCE_AND_ACCOUNTING, COMMUNICATION, SETTINGS_MANAGEMENT, SUPPLIES_MANAGEMENT_READ_ONLY

Unique items

name*

Type: string

令牌的名称。

Min length: 1

Max length: 100

ApiKeyScopeType

方法的访问:

ALL_METHODS — 全柜管理。
ALL_METHODS_READ_ONLY — 查看机柜中的所有信息。
INVENTORY_AND_ORDER_PROCESSING — 货物的订单处理和核算。
INVENTORY_AND_ORDER_PROCESSING_READ_ONLY — 查看有关订单的信息。
PRICING — 价格管理。
PRICING_READ_ONLY — 查看价格。
OFFERS_AND_CARDS_MANAGEMENT — 商品和卡片的管理。
OFFERS_AND_CARDS_MANAGEMENT_READ_ONLY — 查看产品和卡片。
PROMOTION — 产品推广。
PROMOTION_READ_ONLY — 查看有关产品促销的信息。
FINANCE_AND_ACCOUNTING — 查看财务信息和报表。
COMMUNICATION — 与客户的沟通。
SETTINGS_MANAGEMENT — 设立商店。
SUPPLIES_MANAGEMENT_READ_ONLY — 获取有关 FBY-申请。

Type	Description
ApiKeyScopeType	Enum: `ALL_METHODS`, `ALL_METHODS_READ_ONLY`, `INVENTORY_AND_ORDER_PROCESSING`, `INVENTORY_AND_ORDER_PROCESSING_READ_ONLY`, `PRICING`, `PRICING_READ_ONLY`, `OFFERS_AND_CARDS_MANAGEMENT`, `OFFERS_AND_CARDS_MANAGEMENT_READ_ONLY`, `PROMOTION`, `PROMOTION_READ_ONLY`, `FINANCE_AND_ACCOUNTING`, `COMMUNICATION`, `SETTINGS_MANAGEMENT`, `SUPPLIES_MANAGEMENT_READ_ONLY`

400 Bad Request

请求包含不正确的数据。有关错误的更多信息

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

OK — 没有错误。
ERROR — 处理请求时出错。

Enum: OK, ERROR

ApiErrorDTO

一般错误格式。

Name

Description

code*

Type: string

的错误代码。

message

Type: string

错误的描述。

401 Unauthorized

请求中未指定授权数据。有关错误的更多信息

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

OK — 没有错误。
ERROR — 处理请求时出错。

Enum: OK, ERROR

403 Forbidden

授权数据不正确或禁止访问资源。有关错误的更多信息

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

OK — 没有错误。
ERROR — 处理请求时出错。

Enum: OK, ERROR

420 Method Failure

已超出资源访问限制。有关错误的更多信息

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

OK — 没有错误。
ERROR — 处理请求时出错。

Enum: OK, ERROR

500 Internal Server Error

市场的内部错误。有关错误的更多信息

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

OK — 没有错误。
ERROR — 处理请求时出错。

Enum: OK, ERROR

这篇文章是否有用？

市场仓库Id(FBY)

派递服务目录