Docs에러 코드

에러 코드 (Errors)

FindIP API는 표준 HTTP 상태 코드를 사용하며, 문제 원인에 대한 세부 정보를 포함한 JSON 에러 응답을 반환합니다.

에러 응답 형식

모든 에러 응답은 다음 구조를 따릅니다:

JSON

{
"detail": "사람이 읽을 수 있는 오류 메시지"
}

코드	상태	설명
`200`	OK	요청이 성공했습니다.
`300`	Multiple Choices	문서 ID가 여러 특허와 일치합니다. (상세 문헌 조회 API 참고)

코드	상태	설명
`400`	Bad Request	잘못된 요청 형식. 필수 필드 누락(예: query) 또는 잘못된 파라미터 타입/값.
`401`	Unauthorized	유효하지 않거나 누락된 API 키. Authorization 헤더를 확인하세요.
`403`	Forbidden	API 키는 유효하지만 해당 작업에 대한 권한이 없습니다.
`404`	Not Found	요청한 리소스를 찾을 수 없습니다. (예: 존재하지 않는 문서 ID)
`429`	Too Many Requests	월 검색 한도를 초과했거나 분당 60회 rate limit에 도달했습니다. 플랜 업그레이드 또는 다음 결제일 리셋까지 대기하세요.

코드	상태	설명
`500`	Internal Server Error	서버에서 예기치 않은 오류가 발생했습니다. 잠시 후 다시 시도하세요.
`503`	Service Unavailable	서버를 일시적으로 사용할 수 없습니다. (점검 또는 과부하)

401 Unauthorized

{
"detail": "Invalid API key"
}

요청에 Authorization: Bearer psk_live_xxx 헤더가 포함되어 있는지 확인하세요.

429 Too Many Requests

{
"detail": "Monthly limit exceeded"
}

월 검색 한도에 도달했습니다. 한도는 결제일 기준 매월 자동으로 리셋됩니다. 상세조회·도면·번호조회는 카운팅하지 않습니다. 사용량 대시보드에서 현황을 확인하세요.

400 Bad Request

{
"detail": "Field 'query' is required"
}

404 Not Found

{
"detail": "Document not found"
}

publication_id 형식을 확인하세요. 국가 코드가 포함된 전체 ID를 사용해야 합니다. (예: 12261291 대신 US12261291B2)