API Teachworks — это программный интерфейс, позволяющий получать доступ к данным в вашей учетной записи Teachworks для разработки пользовательских интеграций и программного обеспечения.
ПРИМЕЧАНИЕ: Доступ к API предоставляется только компаниям, имеющим подписки "Growth" и "Premium".
Включение API
Нажмите на «Учетная запись», а затем на «Интеграции и дополнения».
Воспользуйтесь полем «Поиск» вверху и введите «API».
Переведите переключатель в положение «Вкл.», чтобы активировать API.
Использование
После включения API вы можете перейти по ссылке «Настройки». Для генерации токена API Teachworks нажмите кнопку «Сгенерировать токен API».
Этот ключ вы будете использовать для доступа к своей учетной записи через API. Защитите этот ключ как пароль и не включайте его в общедоступные веб-страницы (для страниц, доступных извне, его следует использовать на стороне сервера).
Вы также можете нажать кнопку «Создать тестовую учетную запись», если хотите создать тестовую учетную запись для проверки интеграции API перед подключением ее к рабочей учетной записи вашей компании.
Документация по API
Документацию по нашему API можно найти здесь: Документация по API Teachworks. В будущем мы добавим в API дополнительные конечные точки для доступа к другим типам данных и управления записями.
Если вас интересует конечная точка, которая в настоящее время недоступна, пожалуйста, свяжитесь с нами по адресу support@teachworks.com , и мы рассмотрим возможность ее добавления.