Sima-Land API v5

https://www.sima-land.ru/api/v5/help
Admin
Sima-Land API v5 provides RESTful access to the Sima-Land product catalog, allowing users to...
Tokens:3,582
Snippets:20
Trust Score:9.9
Update:11 months ago
Show doc for...
Tokens:
Raw
### GET /photo-size

Source: https://www.sima-land.ru/api/v5/help/index

Retrieves all available photo sizes.

```APIDOC
## GET /photo-size

### Description
Получить все размеры фотографий

### Method
GET

### Endpoint
/photo-size

### Parameters

#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **(array)** - List of photo sizes

#### Response Example
```json
[
  {
    "id": 1,
    "name": "small",
    "width": 100,
    "height": 100
  },
  {
    "id": 2,
    "name": "medium",
    "width": 300,
    "height": 300
  }
]
```
```

--------------------------------

### Resource Relationships and Photos

Source: https://www.sima-land.ru/api/v5/help/index

Explains how product photos are linked and the structure of photo-related fields in the `items` resource.

```APIDOC
## Resource Relationships and Photos

### Item Resource Photo Fields

The `items` resource contains the following fields related to photos:
- `agg_photos`: Contains a list of photo indices.
- `base_photo_url`: Contains the base URL for retrieving photos.

To construct the full URL of a photo, append the photo index and desired size filename to the `base_photo_url`.

**Example:**
- `base_photo_url`: `https://goods-photos.static1-sima-land.com/items/825578/`
- Photo index: `0`
- Filename: `700.jpg`
- Full URL: `https://goods-photos.static1-sima-land.com/items/825578/0/700.jpg`

A list of all possible filenames can be obtained [here](link_to_possible_filenames_list).
```

--------------------------------

### Item API

Source: https://www.sima-land.ru/api/v5/help/index

Endpoints for retrieving product information.

```APIDOC
## Item API

### Get All Items

- **Method:** GET
- **Endpoint:** `/item`
- **Description:** Retrieves all products. Supports pagination via the `p` query parameter.

### Get Item by ID or SID

- **Method:** GET
- **Endpoint:** `/item/{id}`
- **Description:** Retrieves a specific product by its ID or SID.
- **Path Parameters:**
  - **id** (integer/string) - Required - The ID or SID of the item.
```

--------------------------------

### Attribute API

Source: https://www.sima-land.ru/api/v5/help/index

Endpoints for retrieving product attributes.

```APIDOC
## Attribute API

### Get All Attributes

- **Method:** GET
- **Endpoint:** `/attribute`
- **Description:** Retrieves all attributes.

### Get Attribute by ID

- **Method:** GET
- **Endpoint:** `/attribute/{id}`
- **Description:** Retrieves a specific attribute by its ID.
- **Path Parameters:**
  - **id** (integer) - Required - The ID of the attribute.
```

--------------------------------

### General Information

Source: https://www.sima-land.ru/api/v5/help/index

Details about the Sima-land API, including supported data formats, authentication methods, and rate limits.

```APIDOC
## General API Information

### Description
The Sima-land API (www.sima-land.ru) provides RESTful access to the product catalog.

### Response Format
The server responds in either XML or JSON, determined by the client's `Accept` header.
- `application/xml`
- `application/json`

### Request Data Format
The format of data sent to the server depends on the client's `Content-Type` header.
- `application/json`
- `application/xml`

### Date Format
Dates can be in any format that can be correctly processed by PHP's `strtotime` function.

### Authentication
Authentication is performed using JWT. Obtain JWT as described in the relevant section. JWTs are valid for 7 days.

### Pagination
All entity listings are paginated. Use the `p` GET parameter to specify the page number.

### Rate Limits
- Maximum 750 connections per 10 seconds.
- Maximum 50 connections with errors per 10 seconds.
```

--------------------------------

### Category API

Source: https://www.sima-land.ru/api/v5/help/index

Endpoints for retrieving product categories.

```APIDOC
## Category API

### Get All Categories

- **Method:** GET
- **Endpoint:** `/category`
- **Description:** Retrieves all product categories.

### Get Category by ID

- **Method:** GET
- **Endpoint:** `/category/{id}`
- **Description:** Retrieves a specific category by its ID.
- **Path Parameters:**
  - **id** (integer) - Required - The ID of the category.
```

--------------------------------

### Modifier API

Source: https://www.sima-land.ru/api/v5/help/index

Endpoints for retrieving general product modifiers.

```APIDOC
## Modifier API

### Get All Modifiers

- **Method:** GET
- **Endpoint:** `/modifier`
- **Description:** Retrieves all general product modifiers.

### Get Modifier by ID

- **Method:** GET
- **Endpoint:** `/modifier/{id}`
- **Description:** Retrieves a specific general product modifier by its ID.
- **Path Parameters:**
  - **id** (integer) - Required - The ID of the modifier.
```

--------------------------------

### Option API

Source: https://www.sima-land.ru/api/v5/help/index

Endpoints for retrieving attribute option values.

```APIDOC
## Option API

### Get All Options

- **Method:** GET
- **Endpoint:** `/option`
- **Description:** Retrieves all attribute option values.

### Get Option by ID

- **Method:** GET
- **Endpoint:** `/option/{id}`
- **Description:** Retrieves a specific attribute option value by its ID.
- **Path Parameters:**
  - **id** (integer) - Required - The ID of the option.
```

--------------------------------

### API v5 Working Regulations

Source: https://www.sima-land.ru/api/v5/help/index

Information regarding the terms of use for API v5, including JWT token acquisition, data moderation, and usage restrictions.

```APIDOC
## API v5 Working Regulations

### Description
To work with API v5, you need to obtain a JWT token after registration and agreeing to these regulations. All information obtained via API v5 must be moderated for compliance with regional laws before public display. Data is for informational purposes only and may not be exhaustive. Sima-land reserves the right to set limits on API v5 requests.

### Prohibited Uses
- Using provided information materials for purposes other than demonstrating to the end consumer.
- Selling provided information materials.
- Using information materials for developing your own products.
- Unauthorized use of company copyrights (logo, name, design, photos, banners, product mockups, videos).
- Copying trademarks, product mockups, logos, website design, names, or similar elements.
```

--------------------------------

### Data Type API

Source: https://www.sima-land.ru/api/v5/help/index

Endpoints for retrieving data types.

```APIDOC
## Data Type API

### Get All Data Types

- **Method:** GET
- **Endpoint:** `/data-type`
- **Description:** Retrieves all data types.

### Get Data Type by ID

- **Method:** GET
- **Endpoint:** `/data-type/{id}`
- **Description:** Retrieves a specific data type by its ID.
- **Path Parameters:**
  - **id** (integer) - Required - The ID of the data type.
```

--------------------------------

### Trademarks API

Source: https://www.sima-land.ru/api/v5/help/index

Endpoints for retrieving trademark information.

```APIDOC
## GET /trademark

### Description
Получить все торговые марки

### Method
GET

### Endpoint
/trademark

### Parameters

#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **(array)** - List of trademarks

#### Response Example
```json
[
  {
    "id": 1,
    "name": "Brand A"
  },
  {
    "id": 2,
    "name": "Brand B"
  }
]
```
```

```APIDOC
## GET /trademark/{id}

### Description
Получить торговую марку по ID

### Method
GET

### Endpoint
/trademark/{id}

### Parameters

#### Path Parameters
- **id** (integer) - Required - The ID of the trademark to retrieve

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **id** (integer) - The ID of the trademark
- **name** (string) - The name of the trademark

#### Response Example
```json
{
  "id": 1,
  "name": "Brand A"
}
```
```

--------------------------------

### JWT Authentication

Source: https://www.sima-land.ru/api/v5/help/index

Endpoint for obtaining a JWT token for authentication.

```APIDOC
## JWT Authentication

### Sign In (Get JWT)

- **Method:** POST
- **Endpoint:** `/signin`
- **Description:** Obtains a JWT token for authentication purposes. Requires valid credentials (details not provided in source text).

### Request Body Example

```json
{
  "username": "your_username",
  "password": "your_password"
}
```

### Success Response (200)

- **token** (string) - The JWT token.
```

--------------------------------

### Country API

Source: https://www.sima-land.ru/api/v5/help/index

Endpoints for retrieving country information.

```APIDOC
## Country API

### Get All Countries

- **Method:** GET
- **Endpoint:** `/country`
- **Description:** Retrieves all countries.

### Get Country by ID

- **Method:** GET
- **Endpoint:** `/country/{id}`
- **Description:** Retrieves a specific country by its ID.
- **Path Parameters:**
  - **id** (integer) - Required - The ID of the country.
```

--------------------------------

### Units of Measurement API

Source: https://www.sima-land.ru/api/v5/help/index

Endpoints for retrieving units of measurement.

```APIDOC
## GET /unit

### Description
Получить все единицы измерения

### Method
GET

### Endpoint
/unit

### Parameters

#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **(array)** - List of units of measurement

#### Response Example
```json
[
  {
    "id": 1,
    "name": "piece"
  },
  {
    "id": 2,
    "name": "kilogram"
  }
]
```
```

```APIDOC
## GET /unit/{id}

### Description
Получить единицу измерения по ID

### Method
GET

### Endpoint
/unit/{id}

### Parameters

#### Path Parameters
- **id** (integer) - Required - The ID of the unit of measurement to retrieve

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **id** (integer) - The ID of the unit of measurement
- **name** (string) - The name of the unit of measurement

#### Response Example
```json
{
  "id": 1,
  "name": "piece"
}
```
```

--------------------------------

### Item Category API

Source: https://www.sima-land.ru/api/v5/help/index

Endpoints for managing the relationship between items and categories.

```APIDOC
## Item Category API

### Get All Item-Category Links

- **Method:** GET
- **Endpoint:** `/item-category`
- **Description:** Retrieves all links between items and categories.

### Get Item-Category Link by ID

- **Method:** GET
- **Endpoint:** `/item-category/{id}`
- **Description:** Retrieves a specific item-category link by its ID.
- **Path Parameters:**
  - **id** (integer) - Required - The ID of the item-category link.
```

--------------------------------

### Item Attribute API

Source: https://www.sima-land.ru/api/v5/help/index

Endpoints for managing the relationship between items and attributes.

```APIDOC
## Item Attribute API

### Get All Item-Attribute Links

- **Method:** GET
- **Endpoint:** `/item-attribute`
- **Description:** Retrieves all links between items and attributes.

### Get Item-Attribute Link by ID

- **Method:** GET
- **Endpoint:** `/item-attribute/{id}`
- **Description:** Retrieves a specific item-attribute link by its ID.
- **Path Parameters:**
  - **id** (integer) - Required - The ID of the item-attribute link.
```

--------------------------------

### Item Modifier API

Source: https://www.sima-land.ru/api/v5/help/index

Endpoints for managing the relationship between items and modifiers.

```APIDOC
## Item Modifier API

### Get All Item-Modifier Links

- **Method:** GET
- **Endpoint:** `/item-modifier`
- **Description:** Retrieves all links between items and modifiers.

### Get Item-Modifier Link by ID

- **Method:** GET
- **Endpoint:** `/item-modifier/{id}`
- **Description:** Retrieves a specific item-modifier link by its ID.
- **Path Parameters:**
  - **id** (integer) - Required - The ID of the item-modifier link.
```
Tokens:
Raw