라운드 API 개요

Round API

라운드 API를 통해 라운드에 등록된 채용 공고 및 지원서 폼 정보 등을 외부 서비스와 연동할 수 있습니다.

인증

라운드 API를 사용하기 위해서는 API Key 를 발급받으셔야 합니다. 라운드 팀에서 귀사의 API 사용 목적 등을 파악한 후 직접 발급해 드리고 있습니다. 관련 문의는 [email protected] 로 연락 주시기 바랍니다.

인증 방식

발급받으신 API Key를 아래와 같이 Authorization 헤더에 포함시켜 주세요.

authorization: "Bearer {API_KEY}"

발급 받으신 API Key 가 외부로 유출되지 않도록 주의해 주세요.

응답 및 에러

API 응답의 결과는 HTTP 상태코드로 확인하실 수 있습니다.

code	code	설명
400	bad_request	올바르지 않은 요청의 경우
401	unauthorized	인증에 실패했을 경우
403	forbidden	실행 권한이 없는 경우
404	not_found	요청한 리소스를 찾지 못한 경우

인증에 실패했을 경우의 예:

{
  "code": "unauthrized",
  "message": "권한이 없습니다.",
  "key": "string"
}

페이지네이션

요청하신 정보가 복수의 레코드를 반환할 경우 페이지네이션이 적용됩니다. 페이지네이션된 응답은 아래와 같은 포맷으로 반환됩니다.

{
  "collection": [
    ...
  ],
  "pagination": {
    "total": 20,
    "previous_page": "MTk=_N",
    "previous_page_token": "https://api.roundhr.co.kr/v1/{path}?page_token=MTk=_N",
    "next_page": "MTk=_N",
    "next_page_token": "https://api.roundhr.co.kr/v1/{path}?page_token=MTk=_N"
  }
}