REST API
API PeekHire REST дає змогу твоєму власному програмному забезпеченню працювати з твоїми рекрутинговими даними. Це стандартний HTTPS + JSON API, тож будь-яка мова чи інструмент, що може виконувати вебзапити, може ним користуватися.
Переглянь усі ендпоїнти, параметри та схеми в інтерактивному довіднику OpenAPI:
Відкрити довідник APIБазовий URL і версіонування
API має версії. Усі ендпоїнти розташовані під префіксом /api/v1, щоб майбутні
зміни не зламали твою інтеграцію.
Автентифікація
Автентифікуй кожен запит за допомогою ключа API, переданого як bearer token:
curl https://your-api-host/api/v1/campaigns \
-H "Authorization: Bearer YOUR_API_KEY"
Ніколи не вбудовуй ключ API у клієнтський код або публічний репозиторій.
До чого ти маєш доступ
v1 API охоплює основні рекрутингові об’єкти:
- Кампанії — переглядай список і отримуй ролі, на які ти наймаєш.
- Заявки — переглядай список і отримуй відгуки кандидатів.
- Користувачі — переглядай список і отримуй учасників твого робочого простору.
Відповіді мають формат JSON і містять поля, які ти бачиш у застосунку, наприклад назву й статус кампанії або етап і мову заявки.
Пагінація та фільтрація
Ендпоїнти для списків повертають результати сторінками. Використовуй параметри пагінації, щоб переходити між великими наборами результатів, і фільтруй там, де це підтримується, щоб отримувати лише потрібне.
Помилки
API використовує стандартні коди стану HTTP — 2xx для успішних запитів, 4xx для проблем
із твоїм запитом (наприклад, відсутній або недійсний ключ) і 5xx для неочікуваних
помилок сервера. Відповіді з помилками містять повідомлення з описом того, що пішло не так.