20 нояб. 2024 5 минут

Для чего нужен API и как сгенерировать токен для его использования

4530 7
Назад

Что такое API и для чего нужен

API — это программный интерфейс, с помощью которого можно реализовать интеграцию Talantix с другими системами. Действует только в тарифе «Оптимальный».

Важно


API — это не готовая интеграция, а возможность собирать данные из Talantix для работы с ними, а также публиковать или изменять их в системе.

Используя API, вы можете:

1. Выгрузить данные по кандидатам (для систем учёта кадров или сторонних рассыльщиков) или выгрузить сразу весь массив данных по вакансиям, кандидатам, движениям по воронке для аналитических систем (Power BI и подобных).

2. Загрузить в Talantix заявки на вакансии, согласованные в других системах с тем же набором полей, которые уже существуют для заявок в Talantix (1С, Босс-Кадровик, Jira и др.)

3. Загружать в Talantix отклики с собственных карьерных сайтов, страниц реферальной программы компании, а также чат-ботов в мессенджерах и популярных соцсетей. 

Кроме того есть возможность создать сценарий, при котором в Talantix будут подгружаться и изменения в заявке. Например, вы изменили статус согласования заявки в 1С. Вам не нужно будет вручную менять статус заявки в Talantix — изменения подгрузятся автоматически.

Что можно получить при помощи API

  • список заявок
  • детальную информацию о заявке по её ID (идентификатору)
  • данные о текущем пользователе API (общая информация, подключённые интеграции, настройки нотификаций)
  • список кандидатов с поиском по строке и возможными фильтрами
  • информацию о кандидате на вакансии (этап, на котором он сейчас; этап, на котором он был; возраст; зарплата; источник; метки; причины отказа; дата обновления резюме; город)
  • информацию о кандидате по ID (карточка; все резюме; комментарии; вакансии, на которых находится кандидат; история; переписка)
  • информацию о вакансии по ID
  • данные по вакансии, её этапы, кандидаты на каждом этапе, их оценка, сопроводительные письма
  • данные лендинга, сбора откликов, настройки уведомлений, менеджеров внутри вакансии
  • список менеджеров компании
  • шаблоны сообщений
  • подсказки названий этапов при создании новых

Для того, чтобы начать работать с API, вам нужно:

  1. Сгенерировать токен в личном кабинете Talantix. В результате вы получите ссылку.
  2. Полученную ссылку передать своим разработчикам для внедрения. Ссылка будет содержать токен и подробную документацию для разработчиков.

Важно


Сгенерировать токен может только пользователь с правами «Администратор» на платном тарифе Talantix.

Как сгенерировать токен для использования API

Авторизуйтесь в личном кабинете Talantix в учётной записи с правами «Администратор» и перейдите в «Мой профиль» — вкладка «API». Нажмите кнопку «Новый токен».

Вы можете создать несколько токенов. Мы рекомендуем создавать отдельный токен под каждую интеграцию.

Введите название токена, например Bitrix24, и нажмите «Создать».

После того как вы нажали кнопку «Создать», токен будет сгенерирован. Нажмите кнопку «Скопировать».

  • Из соображений безопасности ссылка имеет срок действия — 30 дней, после чего она станет неактивной и нужно будет создавать токен заново.
  • Если в течение 120 дней API с существующими токенами никак не использовали, то не получится их обновить или воспользоваться ими — нужно будет заводить новые токены.

Готово, вы скопировали ссылку. Отправьте её разработчикам для дальнейшей работы. Документацию для разработчика также будет найти по данной ссылке вместе с токеном.

Обратите внимание: после передачи токена разработчики получают доступ ко всем данным аккаунта, которые доступны администратору, создавшему токен.

Как только разработчики воспользуются токеном, ссылка на токен перестанет быть активной. 

Созданные токены будут отображаться во вкладке API с отметкой «Активен» или «Истёк», если срок действия токена закончился.

Вы можете отредактировать название токена или удалить токен.

Обратите внимание: при удалении токена из личного кабинета Talantix, интеграция, которую осуществили с помощью этого токена, перестанет работать.

Смена роли и блокировка пользователя, создавшего токены

Если вы захотите сменить роль (передать права администратора другому сотруднику или понизить роль администратора), система предупредит вас о том, что созданные токены перестанут работать.

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

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

Перейти в Talantix

Вам помогла эта статья?
Ответьте — будем понимать, нужно ли её улучшить
Помогла Не помогла
Спасибо, что написали!
Всё прочитаем и доработаем в будущем
Спасибо за оценку!
Ваше мнение очень важно для нас
Письмо команде hh.ru
 
Пропустить
Статьёй можно поделиться
Похожие статьи
Мой профиль
Настройки компании