Центр документации
Карта сайта


Новая документация

Настройка платежных систем
Настройка способа оплаты КупиВкредит
Настройка способа оплаты Acquiro
Настройка способа оплаты AvisoSMS

Обновленная документация 

Разработчикам (API)
Руководство пользователя

Общее описание

Для доступа к вебсервисам используется единая фронтовая точка доступа /ami_service.php

За публичное REST API отвечает системный модуль "Сервис > Вебсервисы" (ami_webservice).

Управление данному модулю передается в том случае, если к точке доступа пришел запрос с service = ami_webservice.

Для доступа к любому методу вебсервиса (кроме sys.auth) требуется авторизация приложения. Для метода sys.auth требуется предоставление apiKey.

Некоторые методы требуют наличия авторизации пользователя Amiro.CMS.

Сервис может работать в быстром или полном окружении (регулируется параметром fullEnv). Полное окружение требуется для действий связанных с модификацией данных или требующих авторизацию пользователя Amiro.CMS.

Вебсервис возвращает ответ в формате JSON:

{data: RESPONSE}

Где RESPONSE - ассоциативный массив данных ответа.

REQUEST

Параметр
Обязательный
Значение
Описание
service+ami_webserviceПередача управления модулю webservices для обработки действия
version+1.1Версия протокола
fullEnv 0/1Использовать быстрое или полное окружение (по умолчанию 0)
action+#stringМетод сервиса, например sys.auth, sys.info, sys.item_list и т.д.
apiKey #stringТребуется для авторизации приложения
appToken #stringТребуется для доступа приложения к методам
userToken #stringТребуется для доступа приложения к методам требующим авторизацию
modId #stringМодуль в контексте которого необходимо выполнить метод

RESPONSE

Ключ
Тип
Описание
errorCode#stringКод ошибки, либо ОК в случае успешного выполнения
errorMessage#stringТекст сообщения об ошибке, либо пустая строка

ОБЩИЕ КОДЫ ОШИБОК

Код
Описание
ОКЗапрос выполнен успешно
ERR_FAILЗапрос не выполнен (более подробная информация содержится в errorMessage)
ERR_INVALID_ACTIONПередан неизвестный системе параметр action
ERR_MISSING_REQUIRED_ARGUMENTПропущен обязательный параметр
ERR_INVALID_ARGUMENT_VALUEНедопустимое значение параметра
ERR_INVALID_PROTOCOL_VERSIONНедопустимая версия протокола
ERR_ITEM_ADD_FAILEDОшибка добавления элемента
ERR_ITEM_NOT_FOUNDЭлемент не найден
ERR_FULL_ENV_REQUIREDТребуется полное окружение

 

Установка и настройка Руководство пользователя Интеграция дизайна Разработчикам (API) Документация для скачивания
 2000 – 2011 © Amiro.CMS Все права защищены.