API построено по принципу "Запрос-Ответ".
Обмен данными производится через протокол https.
Запросы отправляются через POST-запрос с параметрами (Content-Type: "application/x-www-form-urlencoded"). Ответ отправляется сервером в формате JSON.
Кодировка запросов и ответов UTF-8.
Общая схема обмена данными
Обмен данными происходит в течение сессии. Максимальная продолжительность сессии - 15 минут. Приложение устанавливает сессию, получает данные с сервера или отправляет их, и завершает сессию.
Общая схема обмена данными:
- Приложение отправляет запрос R0, в ответ получает Token.
- Приложение дописывает к токену API Key, считает хэш сумму SHA256 и отправляет запрос R1 (с токеном и этим хешем в параметрах). Сервер в ответ даёт Session Key, с которым можно выполнять остальные запросы. Session Key действителен в течение 15 минут.
- Приложение выполняет необходимые запросы Rx (см.список ниже), используя полученный Session Key
- Приложение выполняет запрос RE, завершая сессию.
Чего-то не хватает?
Мы развиваем своё API по принципу "добавляем функционал при необходимости". Если Вы хотите выгружать из Системы TWS ещё какие-либо данные, или хотите автоматизировать процесс загрузки каких-то данных в Систему TWS, свяжитесь с нами - вместе обсудим, решим и реализуем. Мы всегда открыты к сотрудничеству и заинтересованы в расширении функционала API.
Обработка ошибок
Каждый ответ сервера содержит поля "error_code" и "error_message". Если значение поля "error_code" не равняется нулю, значит произошла ошибка и в поле "error_message" будет её описание.
Разработка и тестирование
Для экспериментов с API вы можете использовать Демонстрационный Виртуальный Офис. В него добавлена лицензия на использование API, соответственно, там есть действующий ApiKey.
Как получить доступ к демонстрационному офису
Интеграция с 1С
Разработан модуль для интеграции с 1С версий 8.2 - 8.3.