istock.info Public API (@dev)

Download OpenAPI specification:

Products

Изделия Номенклатуры

Find products

Вернет коллекцию изделий, отфильтрованную по параметрам, переданным в запросе. Возвращаются только опубликованные изделия.

Request Body schema: application/json
required

Фильтры поиска изделий

page
integer (page) >= 1
Default: 1

Номер страницы.

itemsLimit = 10000

maxPage = (itemsLimit - itemsPerPage) / itemsPerPage.

Если будет передано нулевое или отрицательное значение, page примет default значение.

(внедряется в проекте постепенно)

itemsPerPage
integer (itemsPerPage) [ 1 .. 100 ]
Default: 20

Количество элементов на странице

Если будет передано нулевое или отрицательное значение, itemsPerPage примет default значение.

(внедряется в проекте постепенно)

search
string

Поиск по строке. Если в строке указано целочисленное значение, то поиск производится по точному совпадению UIN. Для остальных значений происходит регистронезависимый поиск по вхождению подстроки в название товара name, тип товара type, обозначение (артикул) designation и любой из тегов tags.

Responses

Response Schema: application/json
Array of objects (product-3)
count
integer

Request samples

Content type
application/json
{
  • "page": 1,
  • "itemsPerPage": 20,
  • "search": "string"
}

Response samples

Content type
application/json
{}

Create product

Authorizations:
publicAPIKeyAuth
Request Body schema: application/json
required

Ограничение на количество операций: 10

Array of items <= 10 items

Импорт товаров

Responses

Request samples

Content type
application/json
{
  • "operations": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Upload product document

Проксирование запроса на загрузку файла в файловое хранилище с помощью интеграционного API. Проксирует запрос на /api/files/product-documents.

Authorizations:
publicAPIKeyAuth
Request Body schema: multipart/form-data
file
required
string <binary>
left
integer
top
integer
width
integer
height
integer
resizeMode
string
Enum: "CROP" "FIT_IN" "FILL"

Responses

Response Schema: application/ld+json
uri
required
string <uri>

File relative uri

Response samples

Content type
application/ld+json
{
  • "uri": "/public-images/6ff0337e-bed8-11eb-acdf-73663c5093ea"
}

Upload product image

Проксирование запроса на загрузку изображения в файловое хранилище с помощью интеграционного API. Проксирует запрос на /api/files/product-images.

Authorizations:
publicAPIKeyAuth
Request Body schema: multipart/form-data
file
required
string <binary>
left
integer
top
integer
width
integer
height
integer
resizeMode
string
Enum: "CROP" "FIT_IN" "FILL"

Responses

Response Schema: application/ld+json
uri
required
string <uri>

File relative uri

Response samples

Content type
application/ld+json
{
  • "uri": "/public-images/6ff0337e-bed8-11eb-acdf-73663c5093ea"
}

PLM Products

Изделия PLM

Find Products

Вернет коллекцию изделий, удовлетворяющую параметрам, переданным в запросе.

Authorizations:
publicAPIKeyAuth
Request Body schema: application/json
required

Поиск изделий

search
string
page
integer (page) >= 1
Default: 1

Номер страницы.

itemsLimit = 10000

maxPage = (itemsLimit - itemsPerPage) / itemsPerPage.

Если будет передано нулевое или отрицательное значение, page примет default значение.

(внедряется в проекте постепенно)

itemsPerPage
integer (itemsPerPage) [ 1 .. 100 ]
Default: 20

Количество элементов на странице

Если будет передано нулевое или отрицательное значение, itemsPerPage примет default значение.

(внедряется в проекте постепенно)

Array of objects

Responses

Response Schema: application/json
Array of objects (product)
count
integer

Request samples

Content type
application/json
{
  • "search": "string",
  • "page": 1,
  • "itemsPerPage": 20,
  • "order": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "count": 0
}

Create product

Authorizations:
publicAPIKeyAuth
Request Body schema: application/json
required

Ограничение на количество операций: 10

Array of items <= 10 items

Импорт товаров

Responses

Request samples

Content type
application/json
{
  • "operations": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ]
}

BigFamily Products

Изделия PLM для интеграции BigFamily

Find Products

Вернёт список изделий каталога PLM компании, аутентифицированной по Bearer API-ключу.

Authorizations:
publicAPIKeyAuth
Request Body schema: application/json
required

Поиск изделий BigFamily

search
string
designation
string
state
string
Enum: "draft" "completed" "trashed" "blocked"
updatedSince
string <date-time>
page
integer (page) >= 1
Default: 1

Номер страницы.

itemsLimit = 10000

maxPage = (itemsLimit - itemsPerPage) / itemsPerPage.

Если будет передано нулевое или отрицательное значение, page примет default значение.

(внедряется в проекте постепенно)

itemsPerPage
integer (itemsPerPage) [ 1 .. 100 ]
Default: 20

Количество элементов на странице

Если будет передано нулевое или отрицательное значение, itemsPerPage примет default значение.

(внедряется в проекте постепенно)

Array of objects

Responses

Response Schema: application/json
Array of objects (list_item)
count
integer

Request samples

Content type
application/json
{
  • "search": "string",
  • "designation": "string",
  • "state": "draft",
  • "updatedSince": "2019-08-24T14:15:22Z",
  • "page": 1,
  • "itemsPerPage": 20,
  • "order": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "count": 0
}

Get Product

Вернёт карточку одного изделия. Секции ответа задаются массивом sections.

Authorizations:
publicAPIKeyAuth
Request Body schema: application/json
required

Карточка изделия BigFamily

id
required
string <uuid>
sections
Array of strings
Items Enum: "characteristics" "variations" "documents" "commercial"

Responses

Response Schema: application/json
id
string <uuid>
designation
string
name
string
type
string
object (state)
version
integer
Array of objects (characteristic)
Array of objects (variation)
Array of objects (document)
object (commercial)

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "sections": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "designation": "string",
  • "name": "string",
  • "type": "string",
  • "state": {
    },
  • "version": 0,
  • "characteristics": [
    ],
  • "variations": [
    ],
  • "documents": [
    ],
  • "commercial": {
    }
}

BigFamily Orders

Заявки на производство PLM для интеграции BigFamily

Find Orders

Вернёт список заявок на производство компании, аутентифицированной по Bearer API-ключу. Доступ ограничен правами сотрудника — владельца ключа (project ACL как во внутреннем API).

Authorizations:
publicAPIKeyAuth
Request Body schema: application/json
required

Поиск заявок на производство BigFamily

search
string

Поиск по названию заявки и номеру заказа

status
string
Enum: "waiting" "inProgress" "completed" "rejected" "trashed"

Фильтр по статусу заявки

projectId
string <uuid>

Фильтр по проекту

deadlineFrom
string <date>

Нижняя граница срока исполнения заявки (включительно)

deadlineTo
string <date>

Верхняя граница срока исполнения заявки (включительно)

responsibleManagerId
string <uuid>

Фильтр по ответственному менеджеру

supervisingManagerId
string <uuid>

Фильтр по контролирующему менеджеру

page
integer (page) >= 1
Default: 1

Номер страницы.

itemsLimit = 10000

maxPage = (itemsLimit - itemsPerPage) / itemsPerPage.

Если будет передано нулевое или отрицательное значение, page примет default значение.

(внедряется в проекте постепенно)

itemsPerPage
integer (itemsPerPage) [ 1 .. 100 ]
Default: 20

Количество элементов на странице

Если будет передано нулевое или отрицательное значение, itemsPerPage примет default значение.

(внедряется в проекте постепенно)

Array of objects

Responses

Response Schema: application/json
Array of objects (list_item-2)
count
integer

Общее количество заявок по фильтрам

Request samples

Content type
application/json
{
  • "search": "string",
  • "status": "waiting",
  • "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  • "deadlineFrom": "2019-08-24",
  • "deadlineTo": "2019-08-24",
  • "responsibleManagerId": "d99ebc8d-7b81-4892-8dc9-e1d981f9eacd",
  • "supervisingManagerId": "4ae981ce-52dd-4d90-84a2-67cea0c1724b",
  • "page": 1,
  • "itemsPerPage": 20,
  • "order": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "count": 0
}

Get Order

Вернёт карточку одной заявки на производство. Секции ответа задаются массивом sections. Доступ ограничен правами сотрудника — владельца API-ключа; недоступная заявка возвращается как 404.

Authorizations:
publicAPIKeyAuth
Request Body schema: application/json
required

Карточка заявки на производство BigFamily

id
required
string <uuid>

Идентификатор заявки

sections
Array of strings
Items Enum: "stages" "items" "checklist" "documents"

Запрошенные секции карточки. Если массив не передан, возвращается только обзор без ключей stages, items, checklist и documents. Неизвестная секция приводит к ошибке 400.

Responses

Response Schema: application/json
id
string <uuid> (Идентификатор)
number
string (Номер заказа)
name
string (Название)
object (status)
object or null (Проект)
object or null (Партия)
object or null (Исполнитель)
object or null (Заказчик)
deadline
string or null <date> (Срок)
daysLeft
integer or null (Осталось дней)

Знаковая календарная разница dueDate − сегодня

object or null (Ответственный менеджер)
object or null (Контролирующий менеджер)
createdAt
string <date-time> (Создано)
updatedAt
string <date-time> (Обновлено)
Array of objects (Этапы)
object (checklist)
Array of objects (Изделия)
Array of objects (Документы)

Request samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "sections": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "number": "string",
  • "name": "string",
  • "status": {
    },
  • "project": {
    },
  • "batch": {
    },
  • "contractor": {
    },
  • "customer": {
    },
  • "deadline": "2019-08-24",
  • "daysLeft": 0,
  • "responsibleManager": {
    },
  • "controllingManager": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "stages": [
    ],
  • "checklist": {
    },
  • "items": [
    ],
  • "documents": [
    ]
}

Marketplace categories

Категории каталога iStock Link Marketplace

Marketplace manufacturers

Производители витрины iStock Link Marketplace

Marketplace notifications

Уведомления iStock Link Marketplace

Marketplace products

Товары витрины iStock Link Marketplace