Перейти к основному содержимому

Работа с REST API и конфигуратором в YouGile

REST API YouGile​

YouGile предоставляет REST API, с помощью которого можно автоматизировать управление системой.

Начало работы с API​

  1. Получите ID компании
    Получите ID компании, которой хочется управлять с помощью REST API, указав логин и пароль от аккаунта YouGile.

  2. Сгенерируйте API-ключ
    Получите API-ключ, для этого потребуется логин, пароль и ID компании. API-ключ необходим для авторизации всех дальнейших запросов.

  3. Используйте API-ключ
    Включайте его в каждый запрос, как Authorization: Bearer <ваш_ключ>.

Особенности API-ключей​

  • Ключ не имеет срока действия и не ограничен по количеству запросов.
  • Ограничение по частоте: не более 50 запросов в минуту на одну компанию.
  • Один аккаунт может иметь до 30 активных ключей.
  • API позволяет получать список ключей и удалять их.

Общий формат запросов​

В запросах и ответах API должен использоваться URL из параметра mainPageUrl ваших настроек conf.json

  • Протокол: HTTPS или HTTP для локального использования
  • Базовый URL: https://your-domain.com/api-v2/{resource}
  • Поддерживаемые HTTP-методы: GET, POST, PUT, DELETE
  • Заголовок: Authorization: Bearer <ваш_API_ключ>
  • Тело запроса: данные в формате JSON

Ответы API​

  • Успешные запросы: статус 200 OK или 201 Created
  • Ошибки: статус 3xx, 4xx или 5xx. В теле ответа будет поле error с описанием.

Важно: доступ к действиям через API ограничен правами пользователя. Если у аккаунта нет доступа к определённым функциям в интерфейсе, то и через API они также будут недоступны.

Полная документация по использованию API в YouGile:
https://ru.yougile.com/api-v2#/

Конфигуратор YouGile​

YouGile содержит встроенный конфигуратор (редактор кода), позволяющий адаптировать систему под любые сценарии.

Возможности конфигуратора​

  • Написание и настройка скриптов на JavaScript
  • Гибкая кастомизация логики и интерфейса
  • Встроенная среда разработки - всё, что нужно, уже есть в системе
  • Доступность для пользователей с правами администратора

Как открыть конфигуратор​

Нажмите комбинацию клавиш Ctrl + ~ или зайдите на страницу проектов, нажав на иконку шестерёнки рядом с названием компании и выбрав пункт Настроить.

Дополнительные материалы​

Руководство по работе с конфигуратором:
https://ru.yougile.com/media/docs/yougile-api-manual.pdf

Короткие видео с примерами реализации скриптов: https://help.yougile.com/books/baza-znanii-yougile/page/kak-dorabotat-sistemu

Примеры скриптов:
https://help.yougile.com/books/baza-znanii-yougile/page/primery-skriptov-konfiguratora