Файловый обмен v.2
Важнейшее отличие от предыдущей версии — в поле fc_id появятся символы. Это связанно с изменениями в структуре и переходом на новую БД. Для корректного перехода в запрос введён новый параметр v (см. документацию)
Все подключение к данным производится через HTTPS–запросы к URL https://foodcost.pro/personal/exchange/, с некоторым набором параметров. В ответ на запрос вы получаете его результат в формате XML, который также описан в документации.
Параметры запроса
В каждом запросе должен присутствовать набор обязательных параметров. Также для каждого файла в его документации определены дополнительные параметры, нужные только для его получения. Текстовые значения параметров должны быть переданы в кодировке UTF–8. Одинаковые для всех функций параметры перечислены ниже.
| Параметр | Обязательный | Описание |
|---|---|---|
| LOGIN | Да | Логин пользователя на FOODCOST к которому привязана компания. |
| PASSWORD | Да | Пароль пользователя на FOODCOST к которому привязана компания. |
| KEY | Да | Ключ интеграции, получаемый пользователем после активации подписки на FOODCOST и к которому привязана компания. |
| KEY_SESSION | Да | Идентификатор сессии получается при каждом новом сеансе работы пользователя с вашим приложением. При последующих заходах того же пользователя это значение будет другим, поэтому его нужно сохранить для последующей авторизации. |
| file | Да | Тип данных, доступ к которым требуется получить. |
| v | Да |
Версия файлов, доступ к которым нужно получить. Параметр необязательный. Для доступа к актуальным данным требуется установить значение 2. Если этот параметр не используется, будут загружены данные актуальные для v.1. |
Внимание! При формировании запроса, названия параметров должны быть написаны прописными или строчными буквами так, как указано в настоящей документации.
Порядок следования параметров в запросе значения не имеет.
Первая авторизация
При первой авторизации на сервере, необходимо отправить запрос, в котором передать параметры:
- LOGIN
- PASSWORD
- KEY
- file
Обратите внимание! Не забудьте указать параметр file. В противном случае вы получите ошибку <error>Файл не задан</error>
Пример запроса при первой авторизации
https://foodcost.pro/personal/exchange/?LOGIN=user&PASSWORD=qWerTy&KEY=UHui9B7zAST4AAK9&file=ingredient
Пример ответа в формате XML
<session_authorize>
<session_id value="6HHruUiXtYTfbpc5bNvVA7iFZ16TNOzv"/>
<reg_key value="2199003694315"/>
</session_authorize>
После получения ключа сессии его необходимо записать и повторить запрос к нужному файлу сключом сесии.
Демонстрационные данные
Для того, чтобы конечные пользователи смогли оценить качество сервиса, мы подготовили файлы с демонстрационными данными.
Доступ к демо-данным не требует регистрации или авторизации. Благодаря этому есть возможность организовать демонстрацию выгрузки данных в систему учёта.
Обратите внимание! В связи с изменением структуры БД, демо-данные v.2 и v.1 имеют существенные различия
Для загрузки демо-данных v.2 используйте следующие ссылки:
- Демо Продукты v.2: https://foodcost.pro/personal/exchange/demo/v.2/products.xml
- Демо Блюда и заготовки v.2: https://foodcost.pro/personal/exchange/demo/v.2/dish.xml
