Получение информации об авторизационном токене
Метод доступен для всех моделей.
Если вы используете 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/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 Тип ответа. Возможные значения:
Enum: |
TokenDTO
Информация об авторизационном токене.
Name |
Description |
apiKey* |
Type: ApiKeyDTO Информация о Api-Key-токене. |
ApiResponseStatusType
Тип ответа. Возможные значения:
OK
— ошибок нет.ERROR
— при обработке запроса произошла ошибка.
Type |
Description |
Enum: |
ApiKeyDTO
Информация о Api-Key-токене.
Name |
Description |
authScopes* |
Type: ApiKeyScopeType[] Доступы к методам по Api-Key-токену.
Enum: Unique items |
name* |
Type: string Название токена. Min length: Max length: |
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 |
Enum: |
400 Bad Request
Запрос содержит неправильные данные. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
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: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
420 Method Failure
Превышено ограничение на доступ к ресурсу. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
500 Internal Server Error
Внутренняя ошибка Маркета. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
No longer supported, please use an alternative and newer version.