TenantAPI. Описание взаимодействия сервиса и пакета APS

TenantAPI - REST-интерфейс, позволяющий создавать, активировать и деактивировать учетные записи аккаунтов компаний сервиса МойСклад.

Вызов методов TenantAPI производится с http Basic авторизацией.

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

URL:  /integration/rest/aps51-v2/verify-tenant
Метод доступа: POST
Параметры:

Параметр Тип Длина или диапазон Описание Обязательный Значение по умолчанию
company строка 255 Имя аккаунта компании да нет
companyFullName строка 255 Полное имя компании нет значение параметра company
adminFirstName строка 50 Имя администратора нет Admin
adminLastName строка 50 Фамилия администратора нет нет
adminEmail строка 255 Email администратора да нет
adminPassword строка 32 Пароль администратора да нет

Результат:

Любой код http ответа отличный от 200 - внутренняя ошибка обработки.
Во всех остальных случаях возвращается текст с результатами обработки в формате XML.

Создание учетной записи аккаунта компании

URL: /integration/rest/aps51-v2/install-tenant
Метод доступа: POST
Параметры:

Параметр Тип Длина или диапазон Описание Обязательный Значение по умолчанию
company строка 255 Имя аккаунта компании да нет
companyFullName строка 255 Полное имя компании нет значение параметра company
adminFirstName строка 50 Имя администратора нет Admin
adminLastName строка 50 Фамилия администратора нет нет
adminEmail строка 255 Email администратора да нет
adminPassword строка 32 Пароль администратора да нет
users целое число   Количество пользователей, отрицательное значение - отсутствие ограничения нет -1
units целое число   Количество филиалов, отрицательное значение - отсутствие ограничения нет -1
retailStores целое число   Количество точек продаж, отрицательное значение - отсутствие ограничения нет -1
dbsize целое число   Размер БД, отрицательное значение - отсутствие ограничения нет -1
operations целое число   Количество документов, отрицательное значение - отсутствие ограничения нет -1
attributes целое число   Количество дополнительных атрибутов, отрицательное значение - отсутствие ограничения нет -1
crm логическое true или false Включение в подписку модуля CRM нет нет
tarif число 0,1,4,5,6,7 Тариф, 0 - Бесплатный, 1 - Базовый, 4 - Профессиональный, 5 - Пробный, 6 - Минимальный, 7 - Корпоративный да нет

Результат:

Любой код http ответа отличный от 200 - внутренняя ошибка обработки.
Во всех остальных случаях возвращается текст с результатами обработки в формате XML.

Изменение параметров подписки аккаунта компании

URL: /integration/rest/aps51-v2/configure-tenant
Метод доступа: POST
Параметры:

Параметр Тип Длина или диапазон Описание Обязательный Значение по умолчанию
company строка 255 Имя аккаунта компании да нет
users целое число   Количество пользователей, отрицательное значение - отсутствие ограничения нет -1
units целое число   Количество филиалов, отрицательное значение - отсутствие ограничения нет -1
retailStores целое число   Количество точек продаж, отрицательное значение - отсутствие ограничения нет -1
dbsize целое число   Размер БД, отрицательное значение - отсутствие ограничения нет -1
operations целое число   Количество документов, отрицательное значение - отсутствие ограничения нет -1
attributes целое число   Количество дополнительных атрибутов, отрицательное значение - отсутствие ограничения нет -1
crm логическое true или false Включение в подписку модуля CRM нет нет
tarif число 0,1,4,5,6,7 Тариф, 0 - Бесплатный, 1 - Базовый, 4 - Профессиональный, 5 - Пробный, 6 - Минимальный, 7 - Корпоративный да нет

Результат:

Любой код http ответа отличный от 200 - внутренняя ошибка обработки.
Во всех остальных случаях возвращается текст с результатами обработки в формате XML.

Активизация аккаунта компании

URL: /integration/rest/aps51-v2/enable-tenant/$company
Метод доступа: GET
Параметры:

Параметр Тип Длина или диапазон Описание Обязательный Значение по умолчанию
company строка 255 Имя аккаунта компании да нет

Результат:

Любой код http ответа отличный от 200 - внутренняя ошибка обработки.

Во всех остальных случаях возвращается текст с результатами обработки в формате XML.

Деактивизация аккаунта компании

URL: /integration/rest/aps51-v2/disable-tenant/$company

Метод доступа: GET

Параметры:

Параметр Тип Длина или диапазон Описание Обязательный Значение по умолчанию
company строка 255 Имя аккаунта компании да нет

Результат:

Любой код http ответа отличный от 200 - внутренняя ошибка обработки.

Во всех остальных случаях возвращается текст с результатами обработки в формате XML.

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

URL: /integration/rest/aps51-v2/resources/$company

Метод доступа: GET

Параметры:

Параметр Тип Длина или диапазон Описание Обязательный Значение по умолчанию
company строка 255 Имя аккаунта компании да нет

Результат:

Любой код http ответа отличный от 200 - внутренняя ошибка обработки.

Во всех остальных случаях возвращается текст с описанием ресурсов в формате XML.

TenantAPI.Resources

<resources>
<!--
Отдельный тег на каждый вид ресурса.
id - идентификатор ресурса
value - количество потребленного ресурса
period - период, за который ресурс был потреблен (в настоящий момент не используется)
-->
<resource id="users" value="33" period="0" />
</resources>

Идентификаторы ресурсов

  • users — количество пользователей
  • units — количество филиалов
  • retailStores — количество торговых точек
  • dbsize — размер БД
  • operations — количество документов
  • attributes — количество дополнительных атрибутов

TenantAPI.Output

<output>
<!-- Ошибки, обнаруженные в процессе обработки переданных параметров -->
<errors>
<!-- Ошибка, атрибут id содержит номер ошибки, setting-id содержит код параметра -->
<error id="0001" setting-id="">
<!-- Сообщение об ошибке на указанном языке -->
<message lang="ru">Текст ошибки</message>
<!-- Системное сообщение об ошибке -->
<system>system.error.code</system>
</error>
</errors>
<!-- Значения параметров, созданных при обработке запроса -->
<settings>
<!-- Параметр с идентификатором, указанным в атрибуте id -->
<setting id="admin_username">admin@company</setting>
</settings>
</output>

Идентификаторы ошибок

  • 0001 — компания с указанным именем уже зарегистрирована
  • 0002 — компания с указанным именем не найдена
  • 0003 — параметр не указан
  • 0004 — длина значения параметра превышает допустимый размер
  • 0005 — длина значение параметра меньше допустимого значения
  • 0006 — значение не соответствует формату
  • 0007 — неправильное значение

Идентификаторы параметров

  • users — количество пользователей
  • units — количество филиалов
  • retailStores — количество торговых точек
  • dbsize — размер БД
  • operations — количество документов
  • attributes — количество дополнительных атрибутов
Еще есть вопросы? Отправить запрос

Комментарии