Получение информации о токене авторизации

Info

Console

Метод доступен для моделей: FBY, FBS, Экспресс и 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"
}

Type: object

ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

Example

{
  "status": "OK"
}

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: string

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

ApiKeyDTO

Информация о Api-Key-токене.

Name

Description

authScopes

Type: ApiKeyScopeType[]

Доступы к методам по Api-Key-токену.

Unique items: true

Example

[
  "ALL_METHODS"
]

name

Type: string

Название токена.

Min length: 1

Max length: 100

Example: example

Example

{
  "name": "example",
  "authScopes": [
    "ALL_METHODS"
  ]
}

TokenDTO

Информация о токене авторизации.

Name

Description

apiKey

Type: ApiKeyDTO

Информация о Api-Key-токене.

Example

{
  "name": "example",
  "authScopes": [
    "ALL_METHODS"
  ]
}

Example

{
  "apiKey": {
    "name": "example",
    "authScopes": [
      "ALL_METHODS"
    ]
  }
}

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибке

Body

application/json

{
  "status": "OK"
}

Type: object

ApiErrorDTO

Общий формат ошибки.

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

Описание ошибки.

Example: example

Example

{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

Type: ApiResponse

Стандартная обертка для ответов сервера.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: ApiErrorDTO[] | null

Список ошибок.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Example

{
  "status": "OK"
}

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

application/json

{
  "status": "OK"
}

Type: object

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке

Body

application/json

{
  "status": "OK"
}

Type: object

420 Method Failure

Превышено ограничение на доступ к ресурсу. Подробнее об ошибке

Body

application/json

{
  "status": "OK"
}

Type: object

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json

{
  "status": "OK"
}

Type: object

Была ли статья полезна?

Идентификаторы складов Маркета (FBY)

Справочник служб доставки