11  /  41

Методы REST API v1.0

Все вызовы методов API — это GET или POST — HTTP–запросы к URL https://foodcost.pro/api/1.0/, где 1.0 — версия API, которая может меняться, с некоторым набором параметров. Вы выбираете в документации нужный метод, например, /auth/, формируете запрос согласно документации метода, и осуществляете этот запрос. В ответ на запрос вы получаете его результат в формате JSON, который также описан в документации каждой функции. Кодировка результата — UTF-8.

Типы запросов

FOODCOST принимает следующие типы запросов:

  • GET — используется для получения данных;
  • POST — используется для создания записей;

Токен

При использовании основных методов работы с FOODCOST требуется токен (token).

Токен (token с англ. — «знак, символ; опознавательный знак; жетон») — уникальный набор последовательности символов, который выдаётся пользователю после успешной авторизации и является ключом для доступа к FOODCOST.

Токен меняется после каждого удачного запроса и в ответе выдаётся новый. Не забывайте перезаписывать токен после каждого успешного обращения к сервису.

Для получения первого токена пользователю необходимо:

  1. Создать аккаунт, используя метод /auth/user/new/.
  2. Зарегистрировать компанию, используя метод /auth/company/new/.
  3. Активировать подписку, используя метод /auth/company/{$id/activation/.

Список запросов

Метод Тип запроса Токен Описание
/auth/company/ GET Не требуется Получение списка компаний, ранее зарегистрированных пользователем
/auth/company/{$id/activation/ POST Не требуется Активация подписки, где {ID} — уникальный идентификатор компании
/auth/company/{$id}/ POST Не требуется Редактирование свойств ранее зарегистрированной компании
/auth/company/new/ POST Не требуется Регистрация новой компании
/auth/user/new/ POST Не требуется Регистрация нового пользователя
/currency/ GET Не требуется Получение списка валют
/location/ GET Не требуется Получение параметров местоположения
/nationalcuisine/elements/ GET Требуется Получение списка национальных кухонь
/nutrients/ GET Требуется Получение списка нутриентов
/products/element/{$fc_id}/ GET Требуется Получение свойств элемента Справочника продуктов
/products/element/{$fc_id}/price/ POST Требуется Получение текущих цен элемента Справочника продуктов
/products/keywords/sections/ GET Требуется Получение списка разделов Справочника ключевых слов
/products/keywords/elements/ GET Требуется Получение списка элементов Справочника ключевых слов
/products/search/ GET Требуется Поиск элемента Справочника продуктов
/products/sections/ GET Требуется Получение списка разделов Справочника продуктов
/recipes/element/{$fc_id}/products/ GET Требуется Получение списка ингредиентов в составе и текущую себестоимость элемента Справочника продуктов
/recipes/element/{$id1}/ GET Требуется Получение свойств элемента Сборника рецептур
/recipes/search/ GET Требуется Поиск элемента Сборника рецептур
/recipes/sections/ GET Требуется Получение списка разделов Сборника рецептур
/softwares/ GET Не требуется Получение списка совместимых приложений

Содержание главы:

0