• Версия 1.1
• Версия 1.0

Версия 1.1

Параметры выборки задаются вида $limit, $offset, $orderBy, $count. Количество найденных объектов выводится в HTTP-заголовке "X-Total-Count".

GET /api/v1.1/shops/ — получить все магазины всех сайтов. В результат будут добавлены не более 25 магазинов.

GET /api/v1.1/shops/3/ — получить данные о магазине с идентификатором 3.

GET /api/v1.1/shop_item/345/getPropertyValues/?$expand=property — получить данные о дополнительных свойствах товара с идентификатором 345 (вызов метода getPropertyValues()) с раскрытием данных о свойстве. Информация о модели отображается в свойстве __model_name, целочисленные свойства типа список раскрываются автоматически в свойстве list_item.

Срез данных

Ограничение выборки и задание смещения производится GET-параметрами $limit (по умолчанию 25) и $offset (по умолчанию 0).

GET /api/v1.1/shops/?$limit=10 — получить первые 10 магазинов.

GET /api/v1.1/shops/?$limit=5&$offset=10&$count=true — получить следующие 5 магазинов, начиная с десятого, а также подсчитать общее количество найденных объектов, количество будет в HTTP-заголовке X-Total-Count.

Выборка элементов, являющихся дочерними другому элементу:

GET /api/v1.1/sites/1/shops/ — получить все магазины сайта с идентификатором 1. В результат будут добавлены не более 25 магазинов.

Сортировка

GET /api/v1.1/sites/1/shops/?$orderBy=id DESC — получить все магазины сайта с идентификатором 1, упорядоченные в порядке убывания идентификатора.

Задание сортировки происходит GET-параметром $orderBy, в значении содержащего название поле или название поле и направление сортировки (по умолчанию ASC). Опции $orderBy=id и $orderBy=id ASC идентичны. Допускается указание нескольких сортировок, в этом случае указывается в виде массива ?$orderBy[]=field1 DESC&orderBy[]=field2 ASC

Развертывание связанных свойств

Вы можете выбрать возврат связанного объекта, вложенного в родительский элемент, для этого используется GET-параметр $expand. Указав поля, которые вы хотите расширить, вы можете попросить сервер получить связанные поля и включить объекты в ответ. Названия свойств указываются в единственном числе через запятую, например $expand=shop_group,shop_currency.

Чтобы расширить дочерние свойства, укажите их через точку, например $expand=shop_group.shop.site,shop_currency:

Версия 1.0

Параметры выборки задаются вида limit, offset, orderBy.

GET /api/v1.0/shops/ — получить все магазины всех сайтов. В результат будут добавлены не более 25 магазинов.

GET /api/v1.0/shops/3/ — получить данные о магазине с идентификатором 3.

Срез данных

Ограничение выборки и задание смещения производится GET-параметрами limit (по умолчанию 25) и offset (по умолчанию 0).

GET /api/v1.0/shops/?limit=10 — получить первые 10 магазинов.

GET /api/v1.0/shops/?limit=5&offset=10 — получить следующие 5 магазинов, начиная с десятого.

Выборка элементов, являющихся дочерними другому элементу:

GET /api/v1.0/sites/1/shops/ — получить все магазины сайта с идентификатором 1. В результат будут добавлены не более 25 магазинов.

Сортировка

GET /api/v1.0/sites/1/shops/?orderBy=id DESC — получить все магазины сайта с идентификатором 1, упорядоченные в порядке убывания идентификатора.

Задание сортировки происходит GET-параметром orderBy, в значении содержащего название поле или название поле и направление сортировки (по умолчанию ASC). Опции orderBy=id и orderBy=id ASC идентичны. Допускается указание нескольких сортировок, в этом случае указывается в виде массива ?orderBy[]=field1 DESC&orderBy[]=field2 ASC

Фильтрация выборки в версиях 1.1 и 1.0

Ограничение выборки осуществляется с помощью передачи GET-параметров, виде параметр=значение, например, выбрать все оплаченные заказы в первом магазине:

GET /api/v1.1/shops/1/shop_orders/?paid=1

Операторы фильтрации, которые указываются по схеме параметр|оператор=значение, позволяют строить сложные запросы, например: ?id|gte=77&amount|lt=100

• ne — "!=" не равно;
• lt — "<" меньше;
• gt — ">" больше;
• lte — "≤" меньше или равно;
• gte — "≥" больше или равно.

Количество задаваемых параметров фильтрации не ограничено.

Создание ресурсов методом POST

POST /api/v1.1/shops/ — создание нового магазина

POST /api/v1.1/shops/1/shop_items/ — создание нового товара в первом магазине

Данные о создаваемом элементе передаются в виде JSON. В ответе будет указан идентификатор созданной записи.

Изменение ресурсов методом PUT

PUT /api/v1.1/shop_items/123/ — редактирование товара с идентификатором 123.

Обновляемые данные передаются в виде JSON.

Вызов методов у ресурсов

PUT /api/v1.1/shop_orders/17/paid/ — установить оплачено (вызвать метод paid()) у заказа с идентификатором 17.

Именованные аргументы метода передаются в JSON. Если все ключи args являются числовыми, ключи игнорируются и каждый элемент будет передан в метод как позиционный аргумент, по порядку. Если какие-либо ключи args являются строками, эти элементы будут переданы в параметр callback как именованные аргументы, с именем, заданным ключом.

Если метод возвращает результат, он будет показан вместо ответа OK.

Загрузка изображений

PUT /api/v1.1/shop_item/19/uploadLargeImage/ — загрузить изображение (вызвать метод uploadLargeImage()) у товара с идентификатором 19. Изображение должно быть передано в формате multipart/form-data в поле с именем image.

Удаление ресурсов методом DELETE

DELETE /api/v1.1/shop_items/123/ — удаление товара с идентификатором 123.

DELETE /api/v1.1/shop/1/shop_orders/ — удаление заказов магазина с учетом ограничений выборок, доступны для SELECT.

Получение информации о ресурсе методом OPTIONS

OPTIONS /api/v1.1/shop_items/ — получить информацию о ресурсе shop_items

Вывод ошибок

При возникновении ошибки, в элементе error возвращается code с указанием кода ошибки и message с текстом ошибки.

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

Получение списка заказов первого магазина в формате XML

<?php
header("Content-type: application/json");

require_once('bootstrap.php');

$domain = 'https://site.ru';

$oCore_Http = Core_Http::instance();
$oCore_Http
	->clear()
	->additionalHeader('Accept', 'application/json')
	//->additionalHeader('Accept', 'application/xml')
	->additionalHeader('Accept-Language', 'ru-ru,ru;q=0.8,en-us;q=0.5,en;q=0.3')
	->additionalHeader('Accept-Encoding', 'gzip, deflate')
	->additionalHeader('Authorization', 'Bearer ЗДЕСЬ-УКАЖИТЕ-ТОКЕН')
	->contentType('application/json')
	->method('GET')
	->url($domain . '/api/v1.1/shops/1/shop_orders/?$limit=50')
	->execute();

$sContent = $oCore_Http->getDecompressedBody();

echo $sContent;

если необходима печать заголовков ответе, то выполните

var_dump($oCore_Http->getHeaders());

Создание нового магазина для первого сайта, ответ в JSON

<?php
header("Content-type: application/json");

require_once('bootstrap.php');

$domain = 'https://site.ru';

$requestData = json_encode(
	array(
		'site_id' => 1,
		'name' => 'Новый магазин',
		'shop_currency_id' => 1,
		'email' => 'alexander@site.ru'
	)
);

$oCore_Http = Core_Http::instance();
$oCore_Http
	->clear()
	->additionalHeader('Accept', 'application/json')
	//->additionalHeader('Accept', 'application/xml')
	->additionalHeader('Accept-Language', 'ru-ru,ru;q=0.8,en-us;q=0.5,en;q=0.3')
	->additionalHeader('Accept-Encoding', 'gzip, deflate')
	->additionalHeader('Authorization', 'Bearer ЗДЕСЬ-УКАЖИТЕ-ТОКЕН')
	->contentType('application/json')
	->method('POST')
	->url($domain . '/api/v1.1/shops/')
	->rawData($requestData)
	->execute();

$sContent = $oCore_Http->getDecompressedBody();

echo $sContent;

Загрузка изображения

<?php
header("Content-type: application/json");

require_once('bootstrap.php');

$domain = 'https://site.ru';

$eol = "\r\n";

$boundary = mb_strtoupper(uniqid(time()));
$delimiter = '-------------' . $boundary;

// Исходное изображение, загружаемое товару
$sFilePath = CMS_FOLDER . 'test.jpg';

$rawData = "--" . $delimiter . $eol
	. 'Content-Disposition: form-data; name="image"; filename="' . basename($sFilePath) . '"' . $eol
	. 'Content-Type: ' . Core_Mime::getFileMime($sFilePath) . $eol
	. 'Content-Transfer-Encoding: binary' . $eol;
$rawData .= $eol;
$rawData .= Core_File::read($sFilePath) . $eol;

$rawData .= "--" . $delimiter . "--" . $eol;

$oCore_Http = Core_Http::instance();
$oCore_Http
	->clear()
	->additionalHeader('Accept', 'application/json')
	->additionalHeader('Authorization', 'Bearer ЗДЕСЬ-УКАЖИТЕ-ТОКЕН')
	->method('PUT')
	->url($domain . '/api/v1.1/shop_item/19/uploadLargeImage/')
	->contentType("multipart/form-data; boundary={$delimiter}")
	->rawData($rawData)
	->execute();

$sContent = $oCore_Http->getDecompressedBody();

echo $sContent;

История изменений

Версия 7.1.0

Формат ответа принимается в заголовке Accept вместо Content-Type, формат направленных данных указывается в Content-Type и может принимать значения application/json или multipart/form-data. Добавлена возможность загрузки файлов для магазина и информационных элементов методом PUT uploadLargeImage/uploadSmallImage.

Для значений свойств информация о модели отображается в свойстве __model_name, целочисленные свойства типа список раскрываются автоматически в свойстве list_item.

Версия 7.0.7

Добавлено развертывание связанных свойств $expand.

Версия 7.0.6

Добавлен подсчет общего количества найденных по запросу элементов, через $count=true, количество будет в HTTP-заголовке X-Total-Count.

Версия 6.9.7

Добавлена возможность вызова методов у полученного элемента при GET-запросе.