К основному содержимому

Интеграции через API

Обновлено более 2 нед. назад

⚠️ Доступно в пакете Professional. Заинтересованы? Пожалуйста, напишите нам на sales@peopleforce.io, чтобы узнать больше.

В этой статье вы найдете пошаговую инструкцию по интеграции с помощью API. Процесс интеграции делится на 3 основных этапа: генерация ключа API, выбор запроса и практическое испытание.

⚠️ Обратите внимание, что эти действия могут выполнять только пользователи с правами Администратора.

Шаг 1

  1. Чтобы сгенерировать новый API-ключ, перейдите в Настройки безопасности и нажмите на иконку "API-ключи", расположенную в нижней части поля.

  2. Нажмите + Новый.

  3. Введите Название ключа.

  4. Выберите Тип ключа:

    1. Компания – предоставляет полный доступ к данным вашей организации.

    2. Карьера – ключ с ограниченным доступом для интеграции карьерного сайта или сайта с вакансиями.

  5. При необходимости задайте права доступа.

  6. Если нужно, укажите разрешённые IP-адреса.

  7. Нажмите Сгенерировать, чтобы создать ключ.

  8. После создания API-ключ появится в списке. Скопируйте этот токен, он понадобится вам позже.

Вы можете включать или отключать ключи с помощью переключателя рядом с каждым ключом, что позволяет временно деактивировать интеграции без их удаления.

Шаг 2

Получите доступ к полному списку доступных API-запросов. Вы можете найти страницу с ключами API, нажав на слово ''здесь'' или по ссылке.

После нажатия кнопки "API references" в вашем браузере появится новая вкладка, где вы сможете найти самые популярные API-запросы для Jira, PowerBi, 1С и других систем.

Самые популярные запросы:

2. Каждый запрос по должности сотрудника

3. Полный перечень локаций

4. Любая информация об отделе

5. И запросы на отсуствие:

Шаг 3

Чтобы получить доступ к коду, пожалуйста, выберите язык, которым вы хотите пользоваться, из опций, доступных в правой части страницы. Вставьте токен из первого шага в поле авторизации. Затем нажмите кнопку "Try it!", расположенную внизу кода. Если API настроено правильно на вашей стороне, код вернет статус "200".

Вы или ваш системный администратор/DevOps можете выполнить эту задачу с помощью программы Postman.

Нашли ответ на свой вопрос?