Getting information about the authorization token
The method is available for all models.
If you are using an API Key token, one of the accesses in the list is required to call the method
- inventory-and-order-processing — Order processing and inventory
- inventory-and-order-processing:read-only — View order information
- pricing — Manage prices
- pricing:read-only — View prices
- offers-and-cards-management — Manage products and cards
- offers-and-cards-management:read-only — View products and cards
- promotion — Product promotion
- promotion:read-only — View promotion information
- finance-and-accounting — View financial data and reports
- communication — Customer communication
- settings-management — Store settings
- supplies-management:read-only — View FBY requests
- all-methods — Full account management
- all-methods:read-only — View all data
The method is only available for the Api Key token.
Returns information about the transmitted authorization token.
, Limit: 100 requests per hour |
---|
Request
POST
https://api.partner.market.yandex.ru/auth/token
Responses
200 OK
Information about the authorization token.
Body
application/json
{
"status": "OK",
"result": {
"apiKey": {
"name": "string",
"authScopes": [
"ALL_METHODS"
]
}
}
}
Name |
Description |
result* |
Type: TokenDTO Information about the authorization token. |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
TokenDTO
Information about the authorization token.
Name |
Description |
apiKey* |
Type: ApiKeyDTO Information about the Api Key token. |
ApiResponseStatusType
The type of response. Possible values:
OK
— there are no mistakes.ERROR
— an error occurred while processing the request.
Type |
Description |
Enum: |
ApiKeyDTO
Information about the Api Key token.
Name |
Description |
authScopes* |
Type: ApiKeyScopeType[] Access to methods using the Api Key token.
Enum: Unique items |
name* |
Type: string The name of the token. Min length: Max length: |
ApiKeyScopeType
Access to methods:
ALL_METHODS
— full cabinet management.ALL_METHODS_READ_ONLY
— view all information in the cabinet.INVENTORY_AND_ORDER_PROCESSING
— order processing and accounting of goods.INVENTORY_AND_ORDER_PROCESSING_READ_ONLY
— view information about orders.PRICING
— price management.PRICING_READ_ONLY
— view prices.OFFERS_AND_CARDS_MANAGEMENT
— management of goods and cards.OFFERS_AND_CARDS_MANAGEMENT_READ_ONLY
— view products and cards.PROMOTION
— product promotion.PROMOTION_READ_ONLY
— view information about product promotions.FINANCE_AND_ACCOUNTING
— View financial information and statements.COMMUNICATION
— communication with customers.SETTINGS_MANAGEMENT
— setting up stores.SUPPLIES_MANAGEMENT_READ_ONLY
— receiving information on FBY applications.
Type |
Description |
Enum: |
400 Bad Request
The request contains incorrect data. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
ApiErrorDTO
The general error format.
Name |
Description |
code* |
Type: string The error code. |
message |
Type: string Description of the error. |
401 Unauthorized
The authorization data is not specified in the request. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
403 Forbidden
The authorization data is incorrect or access to the resource is prohibited. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
420 Method Failure
The resource access limit has been exceeded. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
500 Internal Server Error
Internal error in Yandex. Market. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
No longer supported, please use an alternative and newer version.