Резюме

Версия 1.0.3
Дата 01.11.2018
Автор MAXXmarketing GmbH
Email автора marketing@maxx-marketing.net
Сайт автора https://www.webdesigner-profi.de
Лицензия GNU/GPL
Авторское право Copyright (C) 2010 webdesigner-profi.de. All rights reserved

Вступление

API JoomShopping-это надежная система, которая позволяет использовать возможности JoomShopping. Перед использованием API необходимо получить данные авторизации (адрес электронной почты, пароль) пользователя API от администратора сайта, на котором установлен API. Все фрагменты кода написаны на PHP.

Технические требования

PHP 7.0+
MySQL 5.5.3+
or SQL Server 10.50.1600.1+
or PostgreSQL 9.1+
Joomla! 3.8.0+
JoomShopping 4.16.3+

История версий

  • 1.0.3 | 01.11.2018
    • Исправлены сообщения об ошибках авторизации HTTP
    • Добавлен подраздел Пример документации
  • 1.0.2 | 30.10.2018
    • Стандартизированы основные функции
  • 1.0.1 | 18.10.2018
    • Интегрирована поддержка дополнений
    • Добавлен раздел содержимого
  • 1.0.0 | 22.02.2018
    • Интегрирована поддержка PHP версии 7.1
    • Интегрирована поддержка PHP версии 7.2
    • Переименована из задачи Wishlisttocart в задачу toCart в разделе список желаний
  • 0.2.6 | 08.12.2017
    • Добавлена задача обновления в разделе корзина
    • Добавлена задача обновления в разделе список желаний
    • Добавлена групповая задача в разделе продукта
    • Добавлена задача поиска в разделе продукта
    • Добавлена задача searchInfo в разделе продукта
    • Отдельные отчеты и задачи корзины и списка пожеланий
    • Изменены параметры задачи элемента в разделе категория
  • 0.2.5 | 01.12.2017
    • Удаленный пользователь возвращает параметр задачи CreateInfo раздела пользователя
    • Удален параметр user_id задачи смены пароля раздела пользователя
    • Добавлена задача редактирования в разделе пользователя
    • Добавлена задача editInfo в разделе пользователя
    • Добавлена задача "Группы" в разделе "Пользователь"
    • Добавлена задача заказа в разделе пользователя
    • Добавлена задача "Заказы" в разделе "Пользователь"
    • Добавлена задача "Все заказы" в разделе "Пользователь"

Запрос

Запросы к API выполняются методом POST-запроса с помощью cURL или другого такого же программного обеспечения. Вот структура запроса

 

$curl = curl_init('%site_url%/index.php?option=com_jshopping&controller=addon_api');
curl_setopt($curl, CURLOPT_HTTPHEADER, [
    '%authorization_header%'
]);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query([
    '%arg1_name%' => '%arg1_value%',
    '%arg2_name%' => '%arg2_value%',
    '%arg3_name%' => '%arg3_value%',
    ...
]));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$res = curl_exec($curl);
curl_close($curl);
if ($res !== false) {
    $res = json_decode($res, true);
}
exit(var_dump($res));

 

Где %site_url% - это базовый URL-адрес веб-сайта, на котором установлен API, https://www.example.com например.

%authorization_header% - это данные авторизации, отправленные в заголовках.

%argN_name% и %argN_value% являются ключами и значениями массива параметров запроса, обернутыми функцией http_build_query, поскольку они должны быть отправлены только в виде массива.

API возвращает результат в формате, указанном в запросе, по умолчанию это json.

Данные авторизации

Данные авторизации отправляются в заголовках. Это требуется для каждого запроса. При самом первом запросе этот заголовок должен быть таким:

Authorization: Basic %email%:%password%

Где %email%:%password% - строка в кодировке base64 с электронной почтой и паролем пользователя API, объединенная двоеточием.

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

Authorization: Bearer %token%

Авторизация HTTP должна быть включена на сервере веб-сайта, на котором установлен API. Если нет, его можно включить, добавив следующую строку в файл .htaccess на веб-сайте

RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]

Параметры запроса

ИмяТипЗначение по умолчаниюОписание
section string Раздел API
task string Действие, что нужно сделать
format string json Формат ответа
args array Аргументы, необходимые для указанного действия
Connection

Чтобы подключиться к API, отправьте открытую задачу в раздел подключения следующим образом:

$curl = curl_init('%site_url%/index.php?option=com_jshopping&controller=addon_api');
curl_setopt($curl, CURLOPT_HTTPHEADER, [
    '%authorization_header%'
]);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query([
    'section' => 'connection',
    'task'    => 'open'
]));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$res = curl_exec($curl);
curl_close($curl);
if ($res !== false) {
    $res = json_decode($res, true);
}
$token = $res['result'];

После этого запроса токен будет возвращен в результате. Используйте его для всех следующих запросов.

 

Authorization: Bearer %token%

 

Обратите внимание, что у токена есть ограничение по времени, по умолчанию 60 минут. Метка времени токена обновляется после каждого нового запроса, но если в течение этого времени не будет никаких действий, срок действия токена истечет. В этом случае нужно снова получить новый токен, чтобы продолжить использовать API. Ограничение по времени может быть изменено администратором сайта.

Разъединение

Всегда закрывайте соединение после завершения работы с API. Для этого вызовите раздел "Закрыть задачу подключения".

Пример

Инициализация данных доступа:
$site_url = 'https://example.com';
$email    = 'example@email.com';
$password = 'example_password';
Открытие соединения и получение токена:
$curl = curl_init($site_url . '/index.php?option=com_jshopping&controller=addon_api');
curl_setopt($curl, CURLOPT_HTTPHEADER, [
    'Authorization: Basic ' . base64_encode($email . ':' . $password)
]);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query([
    'section' => 'connection',
    'task'    => 'open'
]));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$res = curl_exec($curl);
curl_close($curl);
if ($res !== false) {
    $res = json_decode($res, true);
}
$token = $res['result'];
Получение информации о подключении:
$curl = curl_init($site_url . '/index.php?option=com_jshopping&controller=addon_api');
curl_setopt($curl, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer ' . $token
]);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query([
    'section' => 'connection',
    'task'    => 'info'
]));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$res = curl_exec($curl);
curl_close($curl);
if ($res !== false) {
    $res = json_decode($res, true);
}
$info = $res['result'];
Закрытие соединения:
$curl = curl_init($site_url . '/index.php?option=com_jshopping&controller=addon_api');
curl_setopt($curl, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer ' . $token
]);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query([
    'section' => 'connection',
    'task'    => 'close'
]));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_exec($curl);
curl_close($curl);

Разделы и задачи

Задача
Аргументы
ИмяТипЗначение
по умолчанию
Тип результата
Подробности
addon
ids array
Имя

ids

Описание

Возвращает псевдонимы всех аддонов

Тип возвращаемого значения

array

item
id string
array
Имя

item

Описание

Возвращает информацию о дополнении

Параметры
ИмяТипЗначение по умолчаниюОписание
id string Псевдоним аддона
Тип возвращаемого значения

array

items
ids string array
array  
Имя

items

Описание

Возвращает информацию о дополнениях

Параметры
ИмяТипЗначение по умолчаниюОписание
ids string array Псевдонимы аддонов
Тип возвращаемого значения

array

cart
add
product_id int
quantity int
attributes array
freeattributes array
additional_fields array
bool  
Имя

add

Описание

Добавляет товар в корзину

Параметры
ИмяТипЗначение по умолчаниюОписание
product_id int Идентификатор продукта
quantity int Количество продукта
attributes array Массив атрибутов в формате
int attribut_id string attribut_value
freeattributes array Массив свободных атрибутов в формате
int free_attribut_id string free_attribut_value
additional_fields array Массив дополнительных полей в формате
string field_key string field_value
Тип возвращаемого значения

bool

clear bool  
Имя

clear

Описание

Удаляет все данные из корзины

Тип возвращаемого значения

bool

delete
index int
bool  
Имя

delete

Описание

Удаляет товар из корзины

Параметры
ИмяТипЗначение по умолчаниюОписание
index int Номер товара в корзине
Тип возвращаемого значения

bool

discount
code string
bool  
Имя

discount

Описание

Применяет скидку к корзине

Параметры
ИмяТипЗначение по умолчаниюОписание
code string Код скидки
Тип возвращаемого значения

bool

info array  
Имя

info

Описание

Возвращает информацию о корзине

Тип возвращаемого значения

array

update
quantities int array
bool  
Имя

update

Описание

Обновляет количество товаров в корзине

Параметры
ИмяТипЗначение по умолчаниюОписание
quantities int array Массив новых величин в формате
int product_index int product_quantity
Тип возвращаемого значения

bool

category
ids array  
Имя

ids

Описание

Возвращает идентификаторы всех категорий

Тип возвращаемого значения

array

item
id int
array  
Имя

item

Описание

Возвращает информацию о категории

Параметры
ИмяТипЗначение по умолчаниюОписание
id int Идентификатор категории. Используйте задачу поиска в разделе товаров, чтобы получить категорию товаров
Тип возвращаемого значения

array

items
ids int array
array  
Имя

items

Описание

Возвращает информацию о категориях

Параметры
ИмяТипЗначение по умолчаниюОписание
ids int array Идентификаторы категорий
Тип возвращаемого значения

array

tree array  
Имя

tree

Описание

Возвращает дерево категорий

Тип возвращаемого значения

array

checkout
step2 array  
Имя

step2

Описание

Возвращает информацию, необходимую для выполнения шага № 2. Начните с этого шага, чтобы сделать заказ. Затем вызовите задачу сохранения. Повторите эту процедуру для всех шагов до последнего. Обратите внимание, что некоторые шаги могут быть отключены, поэтому перед выполнением следующего шага всегда проверяйте его номер с помощью возвращаемого параметра next_step или с помощью номера шага задач или шагов

Тип возвращаемого значения

array

step2save
input array
bool  
Имя

step2save

Описание

Делает шаг № 2

Параметры
ИмяТипЗначение по умолчаниюОписание
input array Ввод данных пользователем в формате
string field_key string field_value
Тип возвращаемого значения

bool

step3 array  
Имя

step3

Описание

Возвращает информацию, необходимую для выполнения шага № 3

Тип возвращаемого значения

array

step3save
payment_id int
extra_params array []
bool  
Имя

step3save

Описание

Делает шаг № 3

Параметры
ИмяТипЗначение по умолчаниюDescription
payment_id int Идентификатор платежа
extra_params array [] Дополнительные параметры
Тип возвращаемого значения

bool

step4 array  
Имя

step4

Описание

Возвращает информацию, необходимую для выполнения шага № 4

Тип возвращаемого значения

array

step4save
shipping_id int
extra_params array []
bool  
Имя

step4save

Описание

Делает шаг № 4

Параметры
ИмяТипЗначение по умолчаниюОписание
shipping_id int Идентификатор доставки
extra_params array [] Дополнительные параметры
Тип возвращаемого значения

bool

step5 array  
Имя

step5

Описание

Возвращает информацию, необходимую для выполнения шага № 5

Тип возвращаемого значения

array

step5save
confirmation int
payment_back_link string
extra_params array []
array  
Имя

step5save

Описание

Делает шаг № 5. Эта задача возвращает заполненный параметр payment_form, если требуется оплата, и пустой в противном случае. Чтобы произвести оплату, отобразите содержимое этого параметра в виде HTML версии 5 на нужной странице приложения. В большинстве случаев пользователь приложения будет автоматически перенаправлен на веб-страницу платежной системы, выбранной в задаче step3save. В некоторых случаях (например, "Pay Pal PLUS") пользователю необходимо выбрать некоторые параметры перед перенаправлением. На этой веб-странице пользователю необходимо произвести оплату стандартным способом. После оплаты или отмены пользователь будет перенаправлен обратно в приложение по ссылке, переданной в задаче step5save в качестве параметра payment_back_link. GET параметр act также будет добавлен в обратную ссылку. В большинстве случаев будет равно возвращению, если платеж прошел успешно, отмене, если платеж был отменен, и ошибке, если произошла какая-либо ошибка. Позже, если платеж прошел успешно, платежная система самостоятельно отправит запрос на подтверждение в магазин

Параметры
ИмяТипЗначение по умолчаниюОписание
confirmation int Подтверждение пользователя
payment_back_link string URL, куда пользователь будет перенаправлен после завершения или отмены платежа
extra_params array [] Дополнительные параметры
Тип возвращаемого значения

array

stepNumber int  
Имя

stepNumber

Описание

Получите номер текущего шага

Тип возвращаемого значения

int

steps array  
Имя

steps

Описание

Возвращает номера всех шагов

Тип возвращаемого значения

array

connection
close bool  
Имя

close

Описание

Закрывает текущее соединение с API. Вызывайте его всегда после окончания работы с API

Тип возвращаемого значения

bool

info array  
Имя

info

Описание

Возвращает информацию о текущем соединении с API

Тип возвращаемого значения

array

open string  
Имя

open

Описание

Открывает новое соединение с API и возвращает его токен

Тип возвращаемого значения

string

user array  
Имя

user

Описание

Возвращает информацию о текущем подключенном пользователе API

Тип возвращаемого значения

array

content
cartReturnPolicy array  
Имя

cartReturnPolicy

Описание

Возвращает информацию о политике возврата корзины

Тип возвращаемого значения

array

ids array  
Имя

ids

Описание

Возвращает псевдонимы всех страниц содержимого магазина

Тип возвращаемого значения

array

item
id string
array  
Имя

item

Описание

Возвращает информацию о странице содержимого магазина

Параметры
ИмяТипЗначение по умолчаниюОписание
id string Псевдоним страницы содержимого магазина
Тип возвращаемого значения

array

items
ids string array
array  
Имя

items

Описание

Возвращает информацию о страницах содержимого магазина

Параметры
ИмяТипЗначение по умолчаниюОписание
ids string array Псевдонимы страниц содержимого магазина
Тип возвращаемого значения

array

orderReturnPolicy
order_id int
array  
Имя

orderReturnPolicy

Описание

Возвращает информацию о политике возврата заказа

Параметры
ИмяТипЗначение по умолчаниюОписание
order_id int Идентификатор заказа
Тип возвращаемого значения

array

order
ids array  
Имя

ids

Описание

Возвращает идентификаторы всех заказов

Тип возвращаемого значения

array

item
id int
array  
Имя

item

Описание

Возвращает информацию о заказе

Параметры
ИмяТипЗначение по умолчаниюОписание
id int Идентификатор заказа
Тип возвращаемого значения

array

items
ids int array
array  
Имя

items

Описание

Возвращает информацию о заказах

Параметры
ИмяТипЗначение по умолчаниюОписание
ids int array Идентификаторы заказов
Тип возвращаемого значения

array

states array  
Имя

states

Описание

Возвращает информацию о состояниях заказов

Тип возвращаемого значения

array

product
group
group string
array  
Имя

group

Описание

Возвращает информацию о продуктах указанной группы

Параметры
ИмяТипЗначение по умолчаниюОписание
group string Группа продуктов:
bestseller Самые продаваемые продукты
last Последние добавленные продукты
random Случайный набор продуктов
tophits Самые популярные товары
toprating Самые рейтинговые продукты
Тип возвращаемого значения

array

ids array  
Имя

ids

Описание

Возвращает идентификаторы всех продуктов

Тип возвращаемого значения

array

item
id int
attributes array []
array  
Имя

item

Описание

Возвращает информацию о продукте

Параметры
ИмяТипЗначение по умолчаниюОписание
id int Идентификатор продукта
attributes array [] Массив атрибутов в формате
int attribut_id string attribut_value
Тип возвращаемого значения

array

items
ids int array
array  
Имя

items

Описание

Возвращает информацию о продуктах

Параметры
ИмяТипЗначение по умолчаниюОписание
ids int array Идентификаторы продуктов
Тип возвращаемого значения

array

search
search string ''
search_type string any
categories int array []
include_subcat bool true
manufacturers int array []
vendors int array []
labels int array []
price_from float string 0
price_to float string 0
date_from string ''
date_to string ''
extra_fields array []
order int 1
orderby int 0
limit int 12
limitstart int 0
array  
Имя

search

Описание

Возвращает список найденных продуктов

Параметры
ИмяТипЗначение по умолчаниюОписание
search string '' Поисковый запрос
search_type string any Поиск по:
all Все части поискового запроса
any Любая часть запроса
exact Точное совпадение с запросом

Имеет значение только тогда, когда поисковый запрос не пуст

categories int array [] Идентификаторы категорий
include_subcat bool true Следует ли выполнять поиск по подкатегориям
manufacturers int array [] Идентификаторы производителей
vendors int array [] Идентификаторы поставщиков
labels int array [] Идентификаторы меток
price_from float string 0 Минимальная цена продукта
price_to float string 0 Максимальная цена продукта
date_from string '' Минимальная дата создания продукта в формате YYYY-MM-DD HH:MM:SS
date_to string '' Максимальная дата создания продукта в формате YYYY-MM-DD HH:MM:SS
extra_fields array [] Дополнительные поля продуктов в формате
int extra_field_id string extra_field_value
или
int extra_field_id int array extra_field_values_ids

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

order int 1 Идентификатор свойства, с помощью которого можно заказать продукцию. Один из ключей параметра sorting_products_field_s_select конфигурации магазина. Значение по умолчанию хранится в конфигурации магазина в разделе ключ product_sorting и может быть изменено администратором сайта
orderby int 0 Направление заказа продукции:
0 Восходящий
1 Нисходящий

Значение по умолчанию хранится в конфигурации магазина в разделе product_sorting_direction и может быть изменено администратором сайта

limit int 12 Количество возвращаемых товаров. Значение по умолчанию хранится в конфигурации магазина в разделе ключ count_products_to_page и может быть изменено администратором сайта
limitstart int 0 Начальная позиция продуктов. Используется для разбиения на страницы
Тип возвращаемого значения

array

searchInfo array  
Имя

searchInfo

Описание

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

Тип возвращаемого значения

array

shop
config array  
Имя

config

Описание

Возвращает конфигурацию магазина

Тип возвращаемого значения

array

user
activate
token string
array  
Имя

activate

Описание

Активирует новую учетную запись пользователя. Возвращает информацию о только что активированном пользователе

Параметры
ИмяТипЗначение по умолчаниюОписание
token string Токен активации
Тип возвращаемого значения

array

cancelOrder
id int
order_id int
bool  
Имя

cancelOrder

Описание

Отменяет заказ

Parameters
ИмяТипЗначение по умолчаниюОписание
id int Идентификатор пользователя
order_id int Идентификатор заказа
Тип возвращаемого значения

bool

changePassword
id int
old_password string
new_password string
bool  
Имя

changePassword

Описание

Изменяет пароль пользователя

Параметры
ИмяТипЗначение по умолчаниюОписание
id int Идентификатор пользователя
old_password string Текущий пароль пользователя
new_password string Новый пароль пользователя
Тип возвращаемого значения

bool

create
input array
array  
Имя

create

Описание

Регистрирует нового пользователя. Возвращает информацию о только что зарегистрированном пользователе

Параметры
ИмяТипЗначение по умолчаниюОписание
input array Регистрационные данные в формате
string field_key string field_value
Тип возвращаемого значения

array

createInfo array  
Имя

createInfo

Описание

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

Тип возвращаемого значения

array

edit
id int
input array
bool  
Имя

edit

Описание

Изменяет информацию о пользователе

Параметры
ИмяТипЗначение по умолчаниюОписание
id int Идентификатор пользователя
input array Новые данные пользователя в формате
string field_key string field_value
Тип возвращаемого значения

bool

editInfo array  
Имя

editInfo

Описание

Возвращает информацию для редактирования данных пользователя

Тип возвращаемого значения

array

groups array  
Имя

groups

Описание

Возвращает информацию о группах пользователей

Тип возвращаемого значения

array

ids array  
Имя

ids

Описание

Возвращает идентификаторы всех пользователей

Тип возвращаемого значения

array

item
id int 0
array  
Имя

item

Описание

Возвращает информацию о пользователе

Параметры
ИмяТипЗначение по умолчаниюОписание
id int 0 Идентификатор пользователя. Идентификатор текущего пользователя будет использоваться, если id равен 0
Тип возвращаемого значения

array

items
ids int array
array  
Имя

items

Описание

Возвращает информацию о пользователях

Параметры
ИмяТипЗначение по умолчаниюОписание
ids int array Идентификаторы пользователей
Тип возвращаемого значения

array

login
username string
password string
bool  
Имя

login

Описание

Регистрирует пользователя

Параметры
ИмяТипЗначение по умолчаниюОписание
username string Имя пользователя
password string Пароль пользователя
Тип возвращаемого значения

bool

logout bool  
Имя

logout

Описание

Выводит текущего пользователя из системы

Тип возвращаемого значения

bool

order
id int
order_id int
array  
Имя

order

Описание

Возвращает информацию о заказе пользователя

Параметры
ИмяТипЗначение по умолчаниюОписание
id int Идентификатор пользователя
order_id int Идентификатор заказа
Тип возвращаемого значения

array

orders
id int
orders_ids int array
array  
Имя

orders

Описание

Возвращает информацию о заказах пользователя

Параметры
ИмяТипЗначение по умолчаниюОписание
id int Идентификатор пользователя
orders_ids int array Идентификаторы заказов
Тип возвращаемого значения

array

wishlist
add
product_id int
quantity int
attributes array
freeattributes array
additional_fields array
bool  
Имя

add

Описание

Добавляет товар в список желаний

Параметры
ИмяТипЗначение по умолчаниюОписание
product_id int Идентификатор продукта
quantity int Количество продукта
attributes array Массив атрибутов в формате
int attribut_id string attribut_value
freeattributes array Массив свободных атрибутов в формате
int free_attribut_id string free_attribut_value
additional_fields array Массив дополнительных полей в формате
string field_key string field_value
Тип возвращаемого значения

bool

clear bool  
Имя

clear

Описание

Удаляет все данные из списка желаний

Тип возвращаемого значения

bool

delete
index int
bool  
Имя

delete

Описание

Удаляет продукт из списка желаний

Параметры
ИмяТипЗначение по умолчаниюОписание
index int Номер индекса продукта в списке желаний
Тип возвращаемого значения

bool

info array  
Имя

info

Описание

Возвращает информацию о списке желаний

Тип возвращаемого значения

array

toCart
index int
bool  
Имя

toCart

Описание

Отправляет товар из списка пожеланий в корзину

Параметры
ИмяТипЗначение по умолчаниюОписание
index int Номер индекса продукта в списке желаний
Тип возвращаемого значения

bool

update
quantities int array
bool  
Имя

update

Описание

Обновляет количество продуктов в списке пожеланий

Параметры
ИмяТипЗначение по умолчаниюОписание
quantities int array Массив новых величин в формате
int product_index int product_quantity
Тип возвращаемого значения

bool

Ответ

API возвращает массив со статусом, кодом, отчетом и результатом запроса. Этот массив возвращается в формате, указанном в запросе, по умолчанию это json. Вот пример ответа:

array (size=4)
    'status' => string 'ok' (length=2)
    'code'   => int 1
    'report' => string 'No errors. Success' (length=18)
    'result' => string 'KfAl9WMorrEjKtCPS7M1FHo1szhOlxS4' (length=32)

Статус - это название ответа. Каждый статус имеет свой собственный набор кодов и отчетов.  Вот список возможных отчетов.

Код предназначен для определения ответа программно.

В отчете более подробно описан ответ.

Результат напрямую зависит от ответа.

Ответ будет успешным только в том случае, если его статус в порядке, в противном случае — в нем есть ошибка.

Форматы

API возвращает результат в формате, указанном в запросе, по умолчанию это json. Вот список доступных форматов:

ИмяОписание
json Ответ будет закодирован в формате JSON
var_dump Ответ будет показан как результат функции PHP var_dump. Полезно при тестировании

Отчеты

КодОтчет
addon_error
1 Неизвестный псевдоним аддона
cart_error
1 Неправильное количество
2 Количество меньше минимального
3 Количество больше максимального
4 На складе недостаточно товаров
5 Нет обязательных атрибутов продукта(ов)
6 Нет необходимого атрибута(ов)без продукта (ов)
7 Неизвестный идентификатор атрибута
8 Неизвестное значение атрибута
9 Неизвестный свободный идентификатор атрибута
10 Неизвестный индекс продукта
11 Неправильный код скидки
category_error
1 Идентификатор неизвестной категории
checkout_error
1 Корзина пуста
2 Сумма меньше минимальной
3 Сумма больше максимальной
4 Шаг(и) пропущен(ы)
5 Шаг отключен администратором сайта
6 Без оплаты
7 Ошибка оплаты
8 Без доставки
9 Ошибка доставки
10 Нет подтверждения пользователя
connection_error
1 Нет заголовка авторизации
2 Неправильный тип заголовка авторизации
3 Нет адреса электронной почты
4 Нет пароля
5 Неизвестный адрес электронной почты
6 Неверный пароль
7 Неправильный знак
8 Токен с истекшим сроком действия
9 Вы заблокированы администратором сайта
content_error
1 Неизвестный псевдоним
ok
1 Успех
2 Уведомление
3 Предупреждение
order_error
1 Неизвестный идентификатор заказа
2 Сначала нужно оплатить заказ
3 Не удалось отменить заказ
4 Заказ уже отменен
payment_error
1 Нелицензированная платежная система
2 Не удалось создать форму оплаты
product_error
1 Неизвестный идентификатор продукта
2 Неизвестная группа продуктов
request_error
1 Неизвестный формат
2 Нет раздела
3 Нет задачи
4 Неизвестный раздел
5 Неизвестная задача
6 Нет обязательных аргументов(ов)
7 Неверный аргумент(ы)
8 Доступ запрещен
server_error
1 Внутренняя ошибка сервера
2 Не удалось сохранить данные в базе данных
3 Не удалось обновить данные в базе данных
4 Не удалось получить данные из базы данных
user_error
1 Неизвестный идентификатор пользователя
2 Сначала нужно войти в систему
3 Имя пользователя и пароль не совпадают
4 Неверный старый пароль
5 Нет обязательных полей
6 Нет обязательного поля 'title'
7 Нет обязательного поля 'f_name'
8 Нет обязательного поля 'l_name'
9 Нет обязательного поля 'm_name'
10 Нет обязательного поля 'firma_name'
11 Нет обязательного поля 'client_type'
12 Нет обязательного поля 'firma_code'
13 Нет обязательного поля 'tax_number'
14 Нет обязательного поля 'email'
15 Нет обязательного поля 'birthday'
16 Нет обязательного поля 'u_name'
17 Нет обязательного поля 'u_name'
18 Такое имя пользователя уже используется
19 Пароль слишком длинный
20 Пароль не должен содержать пробелов в начале или конце
21 Пароль не содержит достаточного количества цифр
22 Пароль не содержит достаточного количества символов
23 Пароль не содержит достаточного количества символов верхнего регистра
24 Пароль слишком короткий
25 Нет обязательного поля 'password'
26 Нет обязательного поля 'password2' или пароли не совпадают
27 Нет обязательного поля 'email'
28 Нет обязательного поля 'home'
29 Нет обязательного поля 'apartment'
30 Нет обязательного поля 'street' или 'street_nr'
31 Нет обязательного поля 'zip'
32 Нет обязательного поля 'city'
33 Нет обязательного поля 'state'
34 Нет обязательного поля 'country' или идентификатор неизвестной страны
35 Нет обязательного поля 'phone'
36 Нет обязательного поля 'mobil_phone'
37 Нет обязательного поля 'fax'
38 Нет обязательного поля 'ext_field_1'
39 Нет обязательного поля 'ext_field_2'
40 Нет обязательного поля 'ext_field_3'
41 Нет обязательного поля 'd_title'
42 Нет обязательного поля 'd_f_name'
43 Нет обязательного поля 'd_l_name'
44 Нет обязательного поля 'd_m_name'
45 Нет обязательного поля 'd_firma_name'
46 Нет обязательного поля 'd_firma_code'
47 Нет обязательного поля 'd_tax_number'
48 Нет обязательного поля 'd_email'
49 Нет обязательного поля 'd_birthday'
50 Нет обязательного поля 'd_home'
51 Нет обязательного поля 'd_apartment'
52 Нет обязательного поля 'd_street' или 'street_nr'
53 Нет обязательного поля 'd_zip'
54 Нет обязательного поля 'd_city'
55 Нет обязательного поля 'd_state'
56 Нет обязательного поля 'd_country'
57 Нет обязательного поля 'd_phone'
58 Нет обязательного поля 'd_mobil_phone'
59 Нет обязательного поля 'd_fax'
60 Нет обязательного поля 'd_ext_field_1'
61 Нет обязательного поля 'd_ext_field_2'
62 Нет обязательного поля 'd_ext_field_3'
70 Саморегистрация или самоактивация пользователей отключена
71 Неверный токен активации
72 Не удалось активировать пользователя
73 Учетная запись пользователя не активирована и не заблокирована
74 Заказ не принадлежит текущему пользователю
wishlist_error
1 Неправильное количество
2 Количество меньше минимального
3 Количество больше максимального
4 На складе недостаточно товаров
5 Нет обязательных атрибутов продукта(ов)
6 Нет необходимого атрибута(ов)без продукта (ов)
7 Неизвестный идентификатор атрибута
8 Неизвестное значение атрибута
9 Неизвестный бесплатный идентификатор атрибута
10 Неизвестный индекс продукта
 
 
 
 

Никаких мыслей по поводу “Документация по API для JoomShopping”