상세 응답

DFINERY Export API는 HTTP 응답 코드와 상세 응답 코드를 통해 요청의 성공과 실패를 판단합니다.

HTTP 응답 코드

응답 코드
설명

200 - OK

서버에서 정상적으로 요청을 받았습니다.

400 - Bad Request

요청을 처리할 수 없습니다. 필수 파라미터를 보내지 않았거나, 파라미터 포맷이 잘못되었을 때 돌아오는 응답입니다. 요청 파라미터를 확인해 주세요.

429 - Too Many Requests

비정상적으로 많은 요청을 보냈습니다. 잠시 후 다시 시도해 주세요.

500 - Server Error

서버 내부에서 에러가 발생했습니다

상세 응답

API 호출이 실패한 경우, 상세 응답 결과를 통해 오류에 대해 상세한 정보를 얻을 수 있습니다.

응답 코드
result
message
설명

200

fail

client_connection_closed

클라이언트 연결이 종료되었습니다.

400

fail

invalid_parameter

제공된 요청 파라미터가 잘못되었거나 형식이 맞지 않습니다.

400

fail

exceed_date_range_limit

요청한 시작일이 허용된 범위를 초과하였습니다.

401

fail

unauthorized_token

유효하지 않은 Export 토큰입니다.

429

fail

too_many_api_requests

요청한 API 호출 수가 한도를 초과했습니다.

500

fail

unknown_error

시스템 내부에서 예기치 않은 오류가 발생했습니다.

500

fail

query_error

요청된 데이터베이스 쿼리가 실행되지 않고, 실패하였습니다.

응답 예시

성공

성공 시 헤더를 포함한 csv포맷의 데이터를 응답으로 받게 됩니다. 자세한 사항은 각 API 문서를 참고하시면 됩니다.

exceed_date_range_limit

400 BAD REQUEST
{
    "result": "fail",
    "message": "exceed_date_range_limit"
}

unknown_error

500 INTERNAL_SERVER_ERROR
{
    "result": "fail",
    "message": "unknown_error"
}

Last updated