REST API
FOODCOST: ИНТЕГРАЦИЯ предоставляет возможность внешним разработчикам программными средствами получать и записывать данные в FOODCOST: Электронный сборник рецептур. Одним из способов такого взаимодействия является использование REST API. По всем вопросам, связанным с разработкой, вы можете обратиться в техническую поддержку.
Что такое REST API
REST API определяет набор функций, к которым разработчики могут совершать запросы и получать ответы. Взаимодействие происходит по протоколу HTTP. Преимуществом такого подхода является широкое распространение протокола HTTP, поэтому REST API можно использовать практически из любого языка программирования.
Как использовать API
Все вызовы методов API — это GET, POST или PATCH — HTTP–запросы к URL https://foodcost.pro/api/1.0/, где 1.0 — версия API, которая может меняться, с некоторым набором параметров. Вы выбираете в документации нужный метод, например, /auth/, формируете запрос согласно документации метода, и осуществляете этот запрос. В ответ на запрос вы получаете его результат в формате JSON, который также описан в документации каждой функции. Кодировка результата — UTF-8.
- GET — метод используется для получения данных;
- POST — метод используется для создания записей;
- PATCH — метод используется для обновления данных.
Параметры запроса
В каждом запросе должен присутствовать набор обязательных параметров. Также для каждой функции в ее документации определены дополнительные параметры, нужные только для этой функции. Текстовые значения параметров должны быть переданы в кодировке UTF–8. Одинаковые для всех функций параметры перечислены ниже.
| Имя | Тип | Обязательно | Описание |
|---|---|---|---|
| method | string | Да |
название вызываемого метода, например, POST /auth/
|
| login | int | Да | логин пользователя на сайте foodcost к которому привязана компания |
| password | int | Да | пароль пользователя на сайте foodcost к которому привязана компания |
Внимание! При формировании запроса, названия параметров должны быть написаны прописными или строчными буквами, как указано в настоящей документации.
Порядок следования параметров в запросе значения не имеет.
Режим отладки и демонстрации
Режим отладки предназначен для использования во время отладки приложения и предоставления демонстрационного доступа конечным пользователям.
В отличие от боевого, режим отладки предоставляет доступ к ограниченному набору блюд и продуктов.
Для включения демонстрационного режима необходимо использовать код активации DEMO.
„Боевой” режим
Режим предназначен для использования конечными пользователями. Режим включается автоматически при активации подписки.
