자동화 및 개발자
REST API
캠페인, 지원서, 사용자를 프로그래밍 방식으로 조회하고 관리하세요.
PeekHire REST API를 사용하면 자체 소프트웨어에서 채용 데이터를 다룰 수 있습니다. 표준 HTTPS + JSON API이므로 웹 요청을 보낼 수 있는 모든 언어와 도구에서 사용할 수 있습니다.
인터랙티브 OpenAPI 참조에서 모든 엔드포인트, 파라미터, 스키마를 살펴보세요.
API 레퍼런스 열기기본 URL 및 버전 관리
API에는 버전이 적용됩니다. 모든 엔드포인트는 /api/v1 접두사 아래에 있으므로 향후 변경 사항이 통합을 깨뜨리지 않습니다.
인증
모든 요청은 bearer 토큰으로 전송되는 API 키로 인증하세요.
curl https://your-api-host/api/v1/campaigns \
-H "Authorization: Bearer YOUR_API_KEY"
API 키를 클라이언트 측 코드나 공개 저장소에 절대 포함하지 마세요.
접근할 수 있는 항목
v1 API는 핵심 채용 객체를 다룹니다.
- 캠페인 — 채용 중인 포지션을 목록으로 확인하고 조회합니다.
- 지원서 — 후보자 제출 내용을 목록으로 확인하고 조회합니다.
- 사용자 — 워크스페이스 구성원을 목록으로 확인하고 조회합니다.
응답은 JSON이며, 캠페인의 제목과 상태 또는 지원서의 단계와 언어처럼 앱에서 볼 수 있는 필드를 포함합니다.
페이지네이션 및 필터링
목록 엔드포인트는 결과를 페이지 단위로 반환합니다. 페이지네이션 파라미터를 사용해 큰 결과 집합을 탐색하고, 지원되는 경우 필터를 적용해 필요한 항목만 가져오세요.
오류
API는 표준 HTTP 상태 코드를 사용합니다. 2xx는 성공, 4xx는 요청 문제(예: 누락되었거나 유효하지 않은 키), 5xx는 예상치 못한 서버 오류를 의미합니다. 오류 응답에는 무엇이 잘못되었는지 설명하는 메시지가 포함됩니다.