Page Comparison

GET dam/folders/

Info

icon	false

Получить дерево папок в dam

Список параметров:

Параметр	Тип	Описание	Обязательный
flat	boolean	Отображать плоскую структуру или древовидную, по умолчанию false	нет

Пример запроса

Paste code macro

language	bash
theme	Darkula

curl "[endpoint]/dam/folders/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]

Ответ:

Paste code macro

language	json
theme	Darkula

{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 24,
            "name": "folder",
            "timestamp": "2017-12-06T20:44:18.406823",
            "parent": null,
            "children": [
                {
                    "id": 26,
                    "name": "folder_1",
                    "timestamp": "2017-12-08T16:43:01.814395",
                    "parent": 24,
                    "children": []
                }
            ]
        },
        {
            "id": 31,
            "name": "INBOX",
            "timestamp": "2017-12-13T19:57:46.788752",
            "parent": null,
            "children": []
        }
    ]
}

POST dam/folders/

Info

icon	false

Создать папку в корне или в папке с определенным идентификатором

Список параметров:

Название	Тип	Описание	Обязательный
name	string	название новой папки	да
parent	int	идентификатор папки, в которой будет создана новая	нет

Пример запроса

Paste code macro

language	bash
theme	Darkula

curl -XPOST "[endpoint]/dam/folders/" -d '{"name": "new folder"}' -H "TOKEN: [your_token]" -H "APPID: [your_account_name] -H "Content-Type: application/json"

Ответ:

Paste code macro

language	json
theme	Darkula

{
    "id": 32,
    "name": "new folder",
    "timestamp": "2017-12-19T17:56:06.384536",
    "parent": null
}

GET dam/folders/[id]/

Info

icon	false

Получить дерево подпапок определенного родителя или информацию о папке

Список параметров:

Параметр	Тип	Описание	Обязательный
flat	boolean	Отображать плоскую структуру или древовидную, по умолчанию false	нет

Пример запроса

Paste code macro

language	bash
theme	Darkula

curl -XGET "[endpoint]/dam/folders/32/?flat=true" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]

Ответ:

Paste code macro

language	json
theme	Darkula

{
    "id": 32,
    "name": "new folder",
    "timestamp": "2017-12-19T17:56:06.384536",
    "parent": null
}

PATCH dam/folders/[id]/

Info

icon	false

Переместить и/или переименовать текущую папку

Список параметров:

Название	Тип	Описание	Обязательный
name	string	новое название папки	нет
parent	int	идентификатор папки, в которую будет перемещена текущая	нет

Пример запроса

Paste code macro

language	bash
theme	Darkula

curl -XPATCH "[endpoint]/dam/folders/32/" -d '{"name": "renamed folder", "parent": 24}' -H "TOKEN: [your_token]" -H "APPID: [your_account_name] -H "Content-Type: application/json"

Ответ:

Paste code macro

language	json
theme	Darkula

{
    "id": 32,
    "name": "renamed folder",
    "timestamp": "2017-12-19T17:56:06.384536",
    "parent": 24
}

DELETE dam/folders/[id]/

Info

icon	false

Удаление папки

Список параметров:

Параметр	Тип	Описание	Обязательный
delete_files	boolean	удалить ли файлы вместе с папкой, по умолчанию false. Если false, то файлы из удаляемой папки и всех подпапок будут перемещены в родителя удаляемой папки. Если true, то все файлы будут удалены.	нет

Пример запроса

Paste code macro

language	bash
theme	Darkula

curl -XDELETE "[endpoint]/dam/folders/32/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]

OPTIONS dam/folders/

Info

icon	false

Получение данных необходимых для создания валидной папки

Пример запроса

Paste code macro

language	bash
theme	Darkula

сurl -XOPTIONS "[endpoint]/dam/folders/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]"

Ответ:

Paste code macro

language	json
theme	Darkula

{
    "name": "Groups List",
    "description": "Обрабатывает группы атрибутов",
    "renders": [
        "application/json",
        "text/html"
    ],
    "parses": [
        "application/json",
        "application/x-www-form-urlencoded",
        "multipart/form-data"
    ],
    "actions": {
        "POST": {
            "id": {
                "type": "integer",
                "required": false,
                "read_only": true,
                "label": "ID"
            },
            "name": {
                "type": "string",
                "required": true,
                "read_only": false,
                "label": "Название группы",
                "max_length": 200
            },
            "position": {
                "type": "integer",
                "required": false,
                "read_only": false,
                "label": "Позиция",
                "min_value": -2147483648,
                "max_value": 2147483647
            }
        }
    }
}

GET dam/folders/[id]/files/

Info

icon	false

Получить список файлов в текущей папке

Пример запроса

Paste code macro

language	bash
theme	Darkula

curl -XGET "[endpoint]/dam/folders/32/files/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]

Ответ:

Paste code macro

language	json
theme	Darkula

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 3748,
            "skues": [],
            "original_name": "pp.jpeg",
            "name": "pp.jpeg",
            "text": null,
            "folder": 13,
            "status": 0,
            "mimetype": "image/jpeg",
            "filesize": 19264,
            "size": {
                "width": 640,
                "height": 640
            },
            "thumbnail": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/200x200xPNG/2d39c8cc-db80-11e7-a617-107b448ebd23.PNG",
            "modify_time": "2017-12-07T21:55:22.015728",
            "meta_info": {},
            "tags": []
        }
    ]
}

POST dam/folders/[id]/files/

Info

icon	false

Добавление файла в текущую папку

Список параметров:

Параметр	Тип	Описание	Обязательный
file	file	бинарный файл	на выбор
url	url	ссылка, откуда файл будет скачан	на выбор
name	string	имя файла	нет

Info

icon	false
title	Особое условие

Если были указаны и file и url, то приоритетно файл будет загружен из поля file, а url не будет обработан.

Пример запроса

Paste code macro

language	bash
theme	Darkula

curl -XPOST "[endpoint]/dam/folders/32/files/" -d '{"url": "https://site.com/with/pictures/image.png"}' -H "TOKEN: [your_token]" -H "APPID: [your_account_name] -H "Content-Type: application/json"

Ответ:

Paste code macro

language	json
theme	Darkula

{
    "id": 3752,
    "skues": [],
    "original_name": "image.png
    "name": "image.png",
    "text": null,
    "folder": 13,
    "status": 0,
    "mimetype": "image/png",
    "filesize": 18784,
    "size": {
        "width": 200,
        "height": 200
    },
    "cache": {
        "50x50": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/50x50xPNG/image.png",
        "200x200": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/200x200xPNG/image.png",
        "600x600": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/600x600xPNG/image.png",
        "1000x1000": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/1000x1000xJPEG/image.png"
    },
    "thumbnail": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/200x200xPNG/image.png",
    "modify_time": "2017-12-19T18:22:21.809178",
    "meta_info": {},
    "tags": []
}

GET dam/files/

Info

icon	false

Получить информацию обо всех файлах или поиск определенных

Список параметров:

Параметр	Тип	Описание	Обязательный
name	string	полное имя файла	нет
mask	string	маска файла, например . или *.PNG	нет
folder	int	идентификатор папки в которую будет помещен файл	нет
mimetype	string	mimetype файла, например image/png	нет

Пример запроса

Paste code macro

language	bash
theme	Darkula

curl -XGET "[endpoint]/dam/files/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]

Ответ:

Paste code macro

language	json
theme	Darkula

{
    "count": 3709,
    "next": "https://[your_domain].brandquad.ru/api/public_v2/dam/files/?page=6&page_size=1",
    "previous": "https://[your_domain].brandquad.ru/api/public_v2/dam/files/?page=4&page_size=1",
    "results": [
        {
            "id": 6,
            "skues": [
                "1234325"
            ],
            "original_name": "name.jpg",
            "name": "name.jpg",
            "text": null,
            "folder": 8,
            "status": 0,
            "mimetype": "image/jpeg",
            "filesize": 252097,
            "size": {
                "width": 834,
                "height": 349
            },
            "thumbnail": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/200x200xPNG/image.PNG",
            "modify_time": "2017-11-16T18:08:40.209613",
            "meta_info": {},
            "tags": []
        }
    ]
}

GET dam/files/[id]/

Info

icon	false

Получить информацию о файле

Список параметров:

Параметр	Тип	Описание	Обязательный
size	list<string>	список выражений, файлы какого размера и формата получить, формат выражения: WxHxFITxEXT или WxFITxEXT	нет

Описание выражения:

Параметр	Описание	Значение
FIT	делать ли FIT изображения	T или F
EXT	расширение файла	`PNG`, `JPEG`, `GIF`, `BMP`, `TIFF`, `PDF`
W	`ширина`
H	высота(если не задана, то будет определена из отношения сторон оригинала)

Пример запроса

Paste code macro

language	bash
theme	Darkula

curl -XGET "[endpoint]/dam/files/2/?size=50x50xTxJPEG,200xTxPNG" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]

Ответ:

Paste code macro

language	json
theme	Darkula

{
    "id": 2,
    "skues": [
        "12345",
        "15432",
        "product_sku"
    ],
    "original_name": "image.png",
    "name": "image.png",
    "text": null,
    "folder": 8,
    "status": 0,
    "mimetype": "image/png",
    "filesize": 1239834,
    "size": {
        "width": 638,
        "height": 1181
    },
    "cache": {
        "50x50": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/50x50xJPEG/image.JPEG",
        "200x370": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/200x370xPNG/image.PNG"
    },
    "thumbnail": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/200x200xPNG/image.PNG",
    "modify_time": "2017-12-07T22:40:18.130653",
    "meta_info": {},
    "tags": []
}

POST dam/files/[id]/

Info

icon	false

Добавление файла в папку

Список параметров:

Параметр	Тип	Описание	Обязательный
folder	int	идентификатор папки, в которой будет создан файл	да
file	file	бинарный файл	на выбор
url	url	ссылка откуда файл будет скачан	на выбор
name	string	имя файла	нет

Info

icon	false
title	Особое условие

Если были указаны и file и url, то приоритетно файл будет загружен из поля file, а url не будет обработан.

Пример запроса

Paste code macro

language	bash
theme	Darkula

curl -XPOST "[endpoint]/dam/files/" -d '{"url": "https://site.com/with/pictures/image.png", "folder": 8, "name": "custom_name"}' -H "TOKEN: [your_token]" -H "APPID: [your_account_name] -H "Content-Type: application/json"

Ответ:

Paste code macro

language	json
theme	Darkula

{
    "id": 3753,
    "skues": [],
    "original_name": "image.png
    "name": "image.png",
    "text": null,
    "folder": 13,
    "status": 0,
    "mimetype": "image/png",
    "filesize": 18784,
    "size": {
        "width": 200,
        "height": 200
    },
    "cache": {
        "50x50": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/50x50xPNG/image.png",
        "200x200": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/200x200xPNG/image.png",
        "600x600": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/600x600xPNG/image.png",
        "1000x1000": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/1000x1000xJPEG/image.png"
    },
    "thumbnail": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/200x200xPNG/image.png",
    "modify_time": "2017-12-19T18:22:21.809178",
    "meta_info": {},
    "tags": []
}

PATCH dam/files/[id]/

Info

icon	false

Переименование и/или перенос файла

обязательные параметры(задается один любой, или оба):

Список параметров:

Название	Тип	Описание	Обязательный
name	string	новое имя файла	нет
folder	int	идентификатор папки, в которую необходимо перенести файл	нет

Пример запроса

Paste code macro

language	bash
theme	Darkula

curl -XPATCH "[endpoint]/dam/files/2/" -d '{"name": "another name", "folder": 1}' -H "TOKEN: [your_token]" -H "APPID: [your_account_name] -H "Content-Type: application/json"

Ответ:

Paste code macro

language	json
theme	Darkula

{
    "id": 2,
    "skues": [
        "12345",
        "15432",
        "product_sku"
    ],
    "original_name": "image.png",
    "name": "another name",
    "text": null,
    "folder": 1,
    "status": 0,
    "mimetype": "image/png",
    "filesize": 1239834,
    "size": {
        "width": 638,
        "height": 1181
    },
    "cache": {
        "50x50": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/50x50xPNG/image.png",
        "200x200": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/200x200xPNG/image.png",
        "600x600": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/600x600xPNG/image.png",
        "1000x1000": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/1000x1000xJPEG/image.png"
    },
    "thumbnail": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/200x200xPNG/image.PNG",
    "modify_time": "2017-12-07T22:40:18.130653",
    "meta_info": {},
    "tags": []
}

DELETE dam/files/[id]/

Info

icon	false

Удаление файла

Пример запроса

Paste code macro

language	bash
theme	Darkula

curl -XDELETE "[endpoint]/dam/files/3753/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]

GET dam/files/[id]/links/

Info

icon	false

Получить список связей с товарами

Пример запроса

Paste code macro

language	bash
theme	Darkula

curl -XGET "[endpoint]/dam/files/4/links/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]

Ответ:

Paste code macro

language	json
theme	Darkula

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 3,
            "sku": "123456",
            "dam": {
                "id": 4,
                "name": "123456.png",
                "mimetype": "image/png",
                "size": {
                    "width": 638,
                    "height": 1181
                },
				"url": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/200x200xPNG/123456.png"
            },
            "attribute": {
                "id": 121,
                "name": "Color"
            }
        }
    ]
}

POST dam/files/[id]/links/

Info

icon	false

Создать связи с товарами

Список параметров:

Параметр	Тип	Описание	Обязательный
sku	string	sku товара к которому будет привязан файл	да
attribute	int	идентификатор атрибута по которому произойдет связь	да

Пример запроса

Paste code macro

language	bash
theme	Darkula

curl -XPOST "[endpoint]/dam/files/4/links/" -d '{"sku": "1234_sku", "attribute": 112}' -H "TOKEN: [your_token]" -H "APPID: [your_account_name] -H "Content-Type: application/json"

Ответ:

Paste code macro

language	json
theme	Darkula

{
    "id": 4,
    "sku": "1234_sku",
    "dam": {
        "id": 4,
        "name": "123456.png",
        "mimetype": "image/png",
        "size": {
        	"width": 638,
	       	"height": 1181
        },
		"url": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/200x200xPNG/123456.png"
    },
    "attribute": {
        "id": 112,
        "name": "Attribute"
    }
}

GET dam/files/[id]/links/[id]/

Info

icon	false

Получить информацию о связи

Пример запроса

Paste code macro

language	bash
theme	Darkula

curl -XGET "[endpoint]/dam/files/4/links/4/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]

Ответ:

Paste code macro

language	json
theme	Darkula

{
    "id": 4,
    "sku": "1234_sku",
    "dam": {
        "id": 4,
        "name": "123456.png",
        "mimetype": "image/png",
        "size": {
        	"width": 638,
	       	"height": 1181
        },
		"url": "https://[your_domain].brandquad.ru/media/accounts_data/admc/DAM/CACHE/200x200xPNG/123456.png"
    },
    "attribute": {
        "id": 112,
        "name": "Attribute"
    }
}

DELETE dam/files/[id]/links/[id]/

Info

icon	false

Удалить связь

Пример запроса

Paste code macro

language	bash
theme	Darkula

curl -XDELETE "[endpoint]/dam/files/4/links/4/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]

OPTIONS dam/files/[id]/links/

Info

icon	false

Получение данных необходимых для создания валидной связи файла с продуктом

Пример запроса

Paste code macro

language	bash
theme	Darkula

сurl -XOPTIONS "[endpoint]/dam/files/[id]/links/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]"

Ответ:

Paste code macro

language	json
theme	Darkula

{
    "name": "Dam Files Links List",
    "description": "",
    "renders": [
        "application/json",
        "text/html"
    ],
    "parses": [
        "application/json",
        "application/x-www-form-urlencoded",
        "multipart/form-data"
    ],
    "actions": {
        "POST": {
            "id": {
                "type": "integer",
                "required": false,
                "read_only": true,
                "label": "ID"
            },
            "sku": {
                "type": "string",
                "required": true,
                "read_only": false,
                "label": "Sku",
                "max_length": 300
            },
            "dam": {
                "type": "field",
                "required": false,
                "read_only": true,
                "label": "Dam"
            },
            "attribute": {
                "type": "field",
                "required": false,
                "read_only": true,
                "label": "Attribute"
            }
        }
    }
}

Table of Contents

style	none

Versions Compared

Old Version 2

New Version Current

Key

GET dam/folders/

POST dam/folders/

GET dam/folders/[id]/

PATCH dam/folders/[id]/

DELETE dam/folders/[id]/

OPTIONS dam/folders/

GET dam/folders/[id]/files/

POST dam/folders/[id]/files/

GET dam/files/

GET dam/files/[id]/

POST dam/files/[id]/

PATCH dam/files/[id]/

DELETE dam/files/[id]/

GET dam/files/[id]/links/

POST dam/files/[id]/links/

GET dam/files/[id]/links/[id]/

DELETE dam/files/[id]/links/[id]/

OPTIONS dam/files/[id]/links/