Новая версия REST API
Выпустили API 2.0 с более широким функционалом:
- Существующие запросы получили дополнительные возможности
- Количество запросов значительно расширено – реализована работа с задачами и пользователями, чатами
- Появились Webhooks
- Добавили API-клиент и генератор сниппетов. Система будет автоматически формировать нужные куски кода для разных языков и платформ
- Реализовали встроенные примеры. Это поможет быстро разобраться с настройкой API
Новая версия API несовместима с первой, это нужно учесть тем пользователям, которые хотят перейти с предыдущей версии.
Как использовать
- Получить ключ API (для этого нужен логин и пароль от аккаунта админа компании в YouGile)
- Использовать этот ключ для дальнейших запросов к API
- Ключ API не имеет ограничений по времени и по количеству запросов с его использованием, API позволяет управлять ключами: получать список ключей и удалять ненужные. У каждой компании может быть не более 30 ключей
- Запрос к API – это HTTPS запрос к адресу вида:
- К каждому запросу нужно добавлять заголовки:
- Параметры запроса передаются в виде JSON в теле запроса
- Если запрос был успешно выполнен, то ответ будет иметь статус 200 или 201 (в случае создания новых объектов), если же запрос был неуспешным, статус будет начинаться с 3, 4 или 5 в зависимости от типа ошибки. Также будет присутствовать поле error с описанием ошибки
- Инструкция для каждого запроса находится в меню слева
https://yougile.com/api-v2/{resource}
(http метод GET, POST, PUT или DELETE)
Content-Type: application/json
Authorization: Bearer <ключ API>
Все подробности – в интерактивной Документации