Отримання доступу до API

Автор

API Syrve дозволяє інтегрувати ресторанні процеси із зовнішніми системами: сайтом, мобільним застосунком, CRM, обліковою системою або іншими сервісами.

За допомогою Syrve API можна автоматизувати роботу з меню, замовленнями, доставкою, клієнтами та програмами лояльності.

Отримання доступу

Спочатку зареєструйтеся на порталі розробника Syrve (https://developers.syrve.com/portal/) сама реєстрація дуже проста та інтуїтивно зрозуміла. Після чого створіть застосунок.

Дотримуйтесь підказок.

Після реєстрації ви отримаєте параметри, необхідні для авторизації та роботи з API.

  • appId (ID додатку)
  • clientSecret

Авторизація

Виконайте авторизацію з використанням отриманих параметрів.

Після успішної авторизації сервіс поверне access token, який використовується в наступних запитах до API.

Отримати API-ключ:

  1. Також важливо розуміти що Термін дії API-ключа з метою безпеки клієнтських даних змінилися вимоги до довжини API-логіна. Тепер під час створення нового API-логіна або перегенерації старого довжина API-логіна становитиме 36 символів. Разом із цим в UI транспортного застосунку у вебі в налаштуваннях API-логіна з’явилася можливість вказати термін його дії (закінчення). Максимальний термін – 2 роки. Після завершення вказаного періоду API-логін буде деактивований, користуватися Cloud API з його допомогою буде неможливо доти, доки через UI транспортного застосунку у вебі API-логін не буде перегенерований, після чого для нього можна буде знову вказати термін дії.
  2. Авторизуйтеся за наступним методом: https://api-eu.syrve.live/api/v2/access_token. Для отримання токена використовуйте актуальний endpoint: https://api-eu.syrve.live/api/v2/access_token у запиті передавайте appId і clientSecret, отримані під час реєстрації застосунку. Після успішної авторизації сервіс поверне access token, який використовується в наступних запитах до API.
  3. Після отримання токена рекомендується виконати тестовий запит, наприклад отримання довідкової інформації, щоб переконатися, що:
    • авторизація проходить успішно;
    • токен приймається сервером;
    • застосунок коректно обробляє відповідь API.

Перевірка роботи

Після отримання токена перевірте роботу інтеграції.

Важливо: зміни стосуються всіх інтеграцій, що використовують SyrveTransport, включно з власними розробками клієнтів і рішеннями технологічних партнерів.

Rate Limits наразі залишаються без змін. Для авторизації необхідно передавати appId і clientSecret. Старий метод авторизації буде відключено, тому інтеграції потрібно перевести на новий механізм отримання токена.

Розробнику достатньо один раз отримати appId і clientSecret для свого продукту – ці дані можна використовувати для роботи з різними клієнтами разом з API-ключем кожного конкретного клієнта.

Зміни стосуються лише способу отримання токена доступу. Інші API-методи та endpoint’и залишаються без змін.

Реєстрація на порталі розробників є обов’язковою для всіх користувачів. Для компаній з інших країн портал планується доопрацювати з урахуванням місцевих реквізитів. Окремі системні appId і clientSecret для потреб підтримки також опрацьовуються.

Завдяки своїй універсальності та гнучкості Syrve API дозволяє розробникам створювати власні застосунки та рішення на основі платформи Syrve, що забезпечує ще більшу адаптивність системи.

Основні сфери застосування API Syrve включають:

  1. Управління замовленнями — автоматизація приймання, обробки та передачі замовлень між зовнішніми системами та Syrve.
  2. Інтеграція із системами обліку та ERP — обмін даними про продажі, запаси та фінансові операції для підвищення точності обліку.
  3. Лояльність — автоматизація програм лояльності та аналітики щодо клієнтів.

Існує три види API:

API SyrveServer — “серверний” API, дозволяє працювати з номенклатурою, звітами, документами, даними співробітників, наказами.

API SyrveFront — цей API дозволяє автоматизувати та розширювати функціональність касового інтерфейсу, розробляти інтеграції з платіжними системами, інтеграції з готельними системами або системами лояльності, а також системи оперативного моніторингу.

API SyrveCloud — API для роботи із замовленнями за столом, замовленнями на доставку та банкетами.

FAQ

Облікові дані видаються окремо для кожного розробника чи для кожної інтеграції?

Облікові дані видаються для кожного застосунку. Кожен застосунок має власні App ID і Client Secret.

Чи залежить доступ до API від категорії або типу застосунку?

Ні. На поточному етапі всі зареєстровані застосунки після успішної автентифікації отримують доступ до однакового набору доступних на цей момент методів Syrve Live API.

Чи може одна компанія створити кілька інтеграцій?

Так. Один профіль компанії може містити кілька застосунків.

Скільки користувачів можуть працювати під одним обліковим записом?

Поточний інтерфейс порталу не містить функцій керування командою або запрошення користувачів. Поточний процес передбачає один обліковий запис розробника, один профіль компанії та кілька застосунків.

Що таке moduleId і навіщо він потрібен?

moduleId — це унікальний ідентифікатор вашого інтеграційного модуля або рішення. Він пов’язує ваше рішення з ліцензією Syrve клієнта.

Для POS-плагіна Syrve перевіряє ліцензію під час запуску плагіна. Якщо необхідний moduleId не ліцензований для POS-термінала, плагін не запуститься.

Для хмарного рішення ви можете використовувати moduleId, щоб перевірити, чи має клієнт активну ліцензію на ваше рішення. Використовуйте Licences API, щоб отримати поточний статус ліцензії.

Це корисно, коли ваше рішення продається через Syrve Store. Syrve отримує оплату від клієнта, а ви забезпечуєте роботу інфраструктури сервісу. Перевірка ліцензії дає змогу керувати доступом клієнта до вашого хмарного сервісу залежно від наявності активної підписки.

Підсумок

Поточний процес:

  1. Зареєструвати обліковий запис розробника.
  2. Підтвердити адресу електронної пошти.
  3. Заповнити профіль компанії.
  4. Створити застосунок.
  5. Зберегти App ID і Client Secret.
  6. Отримати токен доступу через /api/v2/access_token.
  7. Використовувати токен для роботи з Syrve Live API.