Увага: Доступ до API можливий лише в тарифному плані Ultimate.
Якщо ви хочете розширити можливості своєї системи, інтегрувати її з іншими сервісами (наприклад, Power BI, онлайн-записом, CRM, мобільним додатком тощо) або створити власне рішення — ви можете скористатися API нашої платформи.
У цій статті ми детально пояснимо, як отримати доступ до API, з чого почати, які вимоги потрібно врахувати, і як проходить процес перевірки та підключення вашої інтеграції.
📝 Крок 1: Початковий запит
Для початку потрібно повідомити нас про бажання створити власну інтеграцію. Зробити це можна будь-яким зручним для вас способом:
- через чат підтримки в системі;
- через email;
- або через менеджера, з яким ви вже працюєте.
Менеджер зв’яжеться з вами для уточнення деталей:
- Яка саме функціональність має бути реалізована?
- Для яких користувачів це буде доступно?
- Хто займається розробкою — ваша команда чи сторонні розробники?
- Які приблизні терміни розробки?
- Контакти розробники (Назва/ПІБ, email)
Це дозволить краще зрозуміти ваші цілі та підготувати відповідну технічну документацію.
📄 Крок 2: Реєстрація інтеграції
Після того як всі організаційні питання будуть узгоджені, ми зареєструємо вашу майбутню інтеграцію в нашій системі.
Вашому розробнику буде надано необхідні доступи:
- Код бази – унікальний ідентифікатор тестової системи;
- Client ID та Client Secret – ці ключі потрібні для авторизації через API;
- Документація API – інструкції щодо того, як взаємодіяти з системою.
Зверніть увагу: ми надаємо доступ лише до тих частин API, які дійсно потрібні для роботи вашої інтеграції.
💻 Крок 3: Розробка інтеграції
Після отримання доступів ваша команда або ваші розробники можуть починати роботу над інтеграцією.
Важливо:
- Дотримуйтесь принципів безпеки при роботі з API (не передавайте ключі у відкритому доступі).
- Уникайте надмірного навантаження на систему (наприклад, не надсилайте запити щосекунди, якщо це не потрібно).
- За потреби ви можете консультуватися з нашим технічним фахівцем через Telegram-канал по API або через менеджера.
✅ Крок 4: Передача на перевірку
Коли розробка завершена і інтеграція готова до тестування, повідомте про це менеджера.
Для перевірки обов’язково надайте наступну інформацію:
- Код вашої бази;
- Client ID та Secret;
- Дата і час, коли буде проведено тест;
- Опис того, що саме має робити інтеграція (на які дії система повинна реагувати).
Ця інформація дозволить нашому технічному спеціалісту протестувати інтеграцію та переконатися, що вона:
- працює коректно;
- не створює надмірного навантаження на систему;
- не несе ризиків для стабільності роботи сервісу.
🔐 Крок 5: Підключення до активної бази
Якщо тестування пройшло успішно, і ми не виявили проблем із продуктивністю чи безпекою, ваша інтеграція буде підключена до активної бази.
Але для цього потрібно ще надати письмову згоду власника бази на використання інтеграції.
⚠️ Важливо знати:
- Якщо під час перевірки ми виявимо помилкові запити, надмірне навантаження або підозрілу активність, ми повідомимо вас про це. Після цього вам потрібно буде оптимізувати інтеграцію.
- До усунення всіх наших зауважень, ми залишаємо за собою право відмовити в підключенні інтеграції.
📬 Підтримка
Якщо у вас виникли питання щодо роботи програми чи API, звертайтеся в службу підтримки за посиланням: 👉https://aihelps.zendesk.com/hc/uk