Базовые понятия

Добро пожаловать в документацию Public API. Ниже приведены основные термины и сущности, используемые в системе.

Основные сущности

• Employee - сотрудник организации. Имеет карточку с персональными данными, историей позиций, трудоустройств и компенсаций.
• Job - открытая позиция в компании.
• Pipeline - воронка найма, состоящая из этапов.
• Applicant - потенциальный кандидат, информация о человеке и его резюме.
• Candidate - апликант, назначенный на конкретную вакансию.
• Actions - история взаимодействий с кандидатом: переводы по этапам, комментарии, письма и другие события.
• Goals - цели и метрики компании, команды или сотрудника.
• Custom Tables - пользовательские таблицы организации (кастомные поля). Могут быть историческими.
• Time-off - отпуска и балансы: категории политик, история начислений/списаний, баланс на дату.

Общие принципы работы API

• Методы /search используются для поиска данных и поддерживают пагинацию.
• По умолчанию search-методы возвращают по 20 элементов на страницу.
• Методы /all возвращают полный справочный список объектов.
• API принимает и возвращает данные в формате JSON.

Технические параметры

• Авторизация происходит через bearer token.
• Используется стандартная схема HTTP-ответов, включая 200, 401, 403, 404, 422, 429.
• Время жизни токена: 45 дней.
• Rate limit: 100 запросов в минуту.
• На стороне интеграции обязательно нужно корректно обрабатывать ошибки авторизации, валидации и лимитов.