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

Создано: Татьяна Соколова, Изменено Ср, 9 Окт на 4:11 PM по Наиль Ринатович Ахмадулин

Полная документация API c примерами.

Smartup - это ERP-система для автоматизации работы агентов по продажам, отдела продаж, финансов, склада, логистики. Это облачное решение для дистрибуции, торгового маркетинга, оптовой и розничной торговли.

API Smartup используются для создания решений интеграции с внешними системами.

В документации подробно описана модель данных, используемая Smartup для обмена информацией с внешними системами, а также принципы работы API.

API работает с такими основными понятиями, как:

document_id - это условное обозначение таких объектов/записей, как movement_id, stocktaking_id, writeoff_id, return_id, input_id, deal_id.

external_id - это идентификатор объектов/записей, присвоенный внешней системой.

Все запросы должны выполняться в кодировке UTF-8. Количество запросов не ограничено.

API работает с протоколом HTTPS, а также использует форматы данных JSON и XML. Все запросы и ответы основаны на методах HTTP.

Как авторизоваться?

Авторизация в системе Smartup происходит по принципу Basic Auth.

Basic — самая простая схема, при которой логин и пароль пользователя передаются в заголовке Authorization в незашифрованной форме (кодированные в base64). Однако при использовании протокола HTTPS (HTTP поверх SSL) это сравнительно безопасно.

Как получить имя пользователя и пароль?

Администратор Smartup может создать пользователя и предоставить логин и пароль для входа. Эти данные можно использовать для авторизации.

Пользователь должен иметь лицензию и доступ к внешним системам, чтобы иметь возможность работать с API.