시작하기

오류

문제가 발생하면 API는 해당하는 HTTP 상태 코드와 함께, error 안에 code와 message가 담긴 본문을 반환합니다.

프로그램에서는 code 값을 사용하세요. message는 디버깅을 돕기 위한 영어 텍스트이며 변경될 수 있습니다.

오류 형식404

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}

키 없음401

{
  "error": {
    "code": "missing_api_key",
    "message": "Send your API key in the X-API-Key header or as Authorization: Bearer <key>."
  }
}

오류 코드

상태	코드	발생 상황
400	`key_in_query`	키가 URL로 전송되었습니다(`api_key`, `apikey`, `key` 또는 `token` 매개변수). 키는 헤더로 보내고 새 키를 생성하세요. 이전 키가 로그에 기록되었을 수 있습니다.
400	`invalid_parameter`	매개변수 값이 잘못되었습니다(예: `per_page`가 최댓값을 초과한 경우).
401	`missing_api_key`	요청에 키가 포함되지 않았습니다.
401	`invalid_api_key`	키가 존재하지 않거나, 폐기되었거나, 키를 소유한 사용자가 비활성화되었습니다.
404	`not_found`	엔드포인트가 존재하지 않거나, 항목이 존재하지 않거나, 사용자가 볼 수 없는 회사의 항목입니다.
404	`organization_not_found`	지정한 `organization` 값은 사용자가 이 유형의 항목을 볼 수 있는 회사에 해당하지 않습니다.
405	`method_not_allowed`	API는 `GET`(및 `HEAD`) 요청만 허용합니다.
429	`rate_limited`	요청 한도에 도달했습니다. `Retry-After`에 표시된 시간(초)만큼 기다리세요.
500	`server_error`	내부 오류입니다. 잠시 후 다시 시도하세요. 문제가 계속되면 지원팀에 문의하세요.

같은 요청을 다시 보내도 되는 경우는 429(Retry-After만큼 기다린 후) 또는 500 응답을 받았을 때뿐입니다. 그 밖의 오류는 요청이나 키를 수정해야 합니다.