API Gateway 개요
    • PDF

    API Gateway 개요

    • PDF

    기사 요약

    API Gateway를 통해 API 호출과 관련된 모든 작업들을 편리하게 진행할 수 있습니다. API를 안정적으로 실행하기 위한 다양한 관리 기능들과 API 사용 현황을 실시간으로 확인할 수 있는 대시보드를 제공합니다. 이를 통해 고객은 보다 효율적으로 비즈니스에 집중할 수 있습니다.

    기본 정보

    API URL

    https://apigateway.apigw.gov-ntruss.com/api/v1
    

    Swagger UI 바로가기

    요청 헤더

    API Gateway API에서 공통으로 사용하는 헤더는 다음과 같습니다.

    항목Required설명
    Content-TypeRequired요청 Body Content Type을 application/json으로 지정 (POST)
    x-ncp-apigw-timestampRequired1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것이다.
    API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
    x-ncp-iam-access-keyRequired포탈 또는 Sub Account에서 발급받은 Access Key ID
    x-ncp-apigw-signature-v2RequiredBody를 Access Key Id와 맵핑되는 SecretKey로 암호화한 서명
    HMAC 암호화 알고리즘은 HmacSHA256 사용

    응답 상태 코드

    API Gateway API에서 공통으로 사용하는 응답 상태 코드는 다음과 같습니다.

    성공

    요청이 성공한 경우, 반환되는 코드는 다음과 같습니다.

    HTTP 상태 코드메시지설명
    200OK요청 성공
    201Created요청의 결과로 새로운 리소스가 생성됨
    202Accepted요청이 수락되었지만 아직 완료되지 않았음
    204No Content요청은 성공했지만 응답 콘텐츠 없음

    실패

    요청이 실패한 경우, 반환되는 코드는 다음과 같습니다.

    HTTP 상태 코드코드메시지설명
    400100Bad Request ExceptionHTTPS 프로토콜이나 UTF-8 인코딩으로 인한 요청 오류
    401200Authentication Failed요청한 리소스를 사용하기 위한 인증 정보가 제공되지 않았거나 유효하지 않음
    401210Permission Denied요청한 리소스에 대한 권한이 없음
    403230Forbidden요청한 리소스에 대한 권한이 없음
    404300Not Found Exception요청한 리소스를 찾을 수 없음
    429400Quota ExceededAPI 사용 한도(Quota)을 초과
    429410Throttle LimitedAPI 요청 속도를 초과
    429420Rate LimitedAPI 요청 속도를 초과
    413430Request Entity Too Large요청 바디 크기가 서버가 처리할 수 있는 한계를 초과
    415440Unsupported Media Type지원되지 않는 미디어 유형
    503500Endpoint Error엔드포인트 연결 에러
    504510Endpoint Timeout엔드포인트 연결 시간 초과
    503520Unknown Endpoint Domain엔드포인트가 인식되지 않거나 설정되지 않았음
    503530Connection Closed By Endpoint엔드포인트에서 연결 종료
    500900Unexpected Error예기치 않은 상황으로 요청 처리 실패

    HTTP/TLS 지원 버전

    API Gateway API에서 지원하는 HTTP/TLS 버전은 다음과 같습니다.

    프로토콜지원 버전
    HTTP
    • HTTP/1.1
    • HTTP/2
    TLS
    • TLSv1.2
    • TLSv1.3

    NAVER Cloud Platform 인증키 및 Signature 생성 가이드 바로가기

    웹 콘솔


    이 문서가 도움이 되었습니까?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.