У цьому посібнику коротко пояснюється, як розпочати роботу з REST API у ConnectedCooking. Зверніть увагу, що цей посібник стосується виключно наших хмарних рішень на базі REST API.
- Спочатку потрібно створити клієнт API у нашому обліковому записі ConnectedCooking. Для цього перейдіть у своєму обліковому записі ConnectedCooking на вкладку «Адміністрування».
- Далі натисніть «Інтеграції». Вкладка «API» доступна лише для адміністраторів облікового запису.
- Потім натисніть «+ Додати новий»
- На наступному екрані вкажіть «ALIAS», призначте ГРУПУ та оберіть тип API. Для запитів API, що стосуються HACCP та даних у вашому обліковому записі ConnectedCooking, вам потрібен тип API «Base API». Після заповнення всіх полів натисніть «Додати API».
- На наступному екрані ви отримаєте облікові дані клієнта API. Будь ласка, збережіть їх у безпечному місці та натисніть «Закрити».
- Після створення клієнта API вам знадобиться інструмент для його використання. Для цього ви можете скористатися curl, Postman або будь-яким іншим інструментом, з яким ви знайомі. У цьому посібнику ми використовуємо Postman.
- Запустіть Postman через програму або у веб-браузері. Потім створіть нову порожню колекцію, натиснувши символ «+», а після цього натисніть «Додати запит». Крім того, ви також можете просто створити новий HTTP-запит, натиснувши «Новий».
- Крім того, вам потрібно змінити щойно створений запит на запит типу POST, щоб отримати токен Bearer за допомогою облікових даних вашого API-клієнта від ConnectedCooking.
- Тому вам слід ознайомитися з документацією до API Аутентифікація | Довідковий центр ConnectedCooking
- У документації пояснюється, що для автентифікації подальших запитів до API необхідно створити токен Bearer.
- Це здійснюється за допомогою POST-запиту. POST-запит використовує таку кінцеву точку: https://app.connectedcooking.com/api/auth/access
- Крім того, у вкладці «Тіло» вашого запиту необхідно встановити тип вмісту «x-www-form-urlencoded». Після цього ім’я користувача, пароль та область дії вашого клієнта API слід ввести у відповідні поля.
- Наприкінці натисніть «Надіслати» — після цього ви маєте отримати свій «accessToken = BearerToken»
- Щоб скористатися щойно створеним BearerToken, вам знадобиться будь-який API.
- Ви можете легко ознайомитися з усіма можливими запитами до API в документації щодо кінцевих точок: Кінцеві точки | Довідковий центр ConnectedCooking
- Наприклад, спробуйте скористатися списком пристроїв «Endpoint».
- Цей запит дуже простий: вам потрібно лише скористатися адресою «https://app.connectedcooking.com», додати до неї «/api/public/devices» та скопіювати й вставити свій «accessToken» із POST-запиту на вкладці «Авторизація», як показано на малюнку нижче. Вам потрібно лише вибрати «Bearer Token» у полі «Auth Type», після чого з’явиться поле «Token».
- Наприкінці також натисніть «Надіслати», після чого ви отримаєте список усіх зареєстрованих пристроїв у вашому обліковому записі ConnectedCooking (цей список буде порожнім, якщо у вашому обліковому записі немає пристроїв).
Цей приклад, по суті, можна застосувати до всіх кінцевих точок.
Вітаємо, тепер ви можете користуватися REST-API у ConnectedCooking!
Якщо вам потрібна додаткова інформація, ознайомтеся з нашою документацією щодо API для ConnectedCooking: Вступ | Довідковий центр ConnectedCooking
