NAVER 연동 API
  • PDF

NAVER 연동 API

  • PDF

NAVER 연동 API의 지원 정보를 확인하고 API 공통 호출 및 인증 방법을 확인합니다.
NAVER 연동 API는 HTTP 헤더에 Client IDClient Secret 값만 전송하면 바로 호출하여 사용할 수 있는 Open API로서 Maps, CLOVA, Papago와 같은 서비스가 해당됩니다.

API 호출

NAVER 연동 API 호출 단계는 다음과 같습니다.

1. Application 등록
2. 인증 정보 확인
3. 서비스 선택

1. Application 등록

API 호출 시 HTTP 헤더에 Client IDClient Secret 값을 포함해서 전송해야 하기 때문에 먼저 Application을 등록해야 합니다. 네이버 클라우드 플랫폼 콘솔에서 Application을 등록하는 방법은 다음과 같습니다.

참고

Application 등록 방법에 대한 자세한 설명은 Application 사용 가이드를 참고해 주십시오.

  1. 네이버 클라우드 플랫폼 콘솔에서 Services > AI·NAVER API > AI·NAVER API 메뉴를 차례대로 클릭해 주십시오.
  2. [Application 등록] 버튼을 클릭해 주십시오.
  3. AI·NAVER API 이용 약관 및 NAVER API 서비스 이용 약관에 동의해 주십시오.
  4. AI·NAVER Service에서 사용할 Application 이름을 등록해 주십시오.
    • 최대 40자까지 가능하나 추후 추가되는 서비스 성격에 따라 화면에 출력되는 Application 이름으로 쓰일 수 있으므로 가급적이면 10 자 이내의 간결한 이름이 권장
  5. Application에서 사용할 서비스를 클릭하여 선택해 주십시오.
    • 네이버 클라우드 플랫폼을 통해 연동할 수 있는 서비스 선택
  6. 선택한 Application에서 이용할 서비스 환경 정보를 입력하고 [등록] 버튼을 클릭해 주십시오.
    • 서비스 URL은 복수 선택이 가능
    • Android 앱 패키지나 iOS Bundle ID는 각각 하나씩만 등록 가능
  7. 등록이 완료되면 AI·NAVER API > Application 에 등록된 Application 목록을 확인해 주십시오.
    • 서비스 구분: 선택한 서비스
    • 당일/당월 사용량 : Application마다 서비스별로 실시간 사용량을 %로 확인(UTC+0 기준)
    • 한도 설정: 이용 한도 직접 조절 가능

2. 인증 정보 확인

Application을 등록을 완료한 후 API 호출에 필요한 Client IDClient Secret 값을 확인하는 방법은 다음과 같습니다.

주의
  • API를 호출하려면 Client IDClient Secret 값을 HTTP 헤더에 포함하여 전송해야 합니다.
  • Application Key는 Client 상에 노출되지 않도록 주의해야 하며, 보안을 위한 재발급이 가능합니다.
  1. 네이버 클라우드 플랫폼 콘솔에서 Services > AI·NAVER API > AI·NAVER API 메뉴를 차례대로 클릭해 주십시오.
  2. Application 목록에서 등록된 Application을 확인한 후 App 이름 아래에 있는 [인증 정보] 버튼을 클릭해 주십시오.
  3. 인증 정보 팝업창이 나타나면 Client IDClient Secret 값을 확인해 주십시오.
    • Application Key
      • Application 이름 : Application을 구분하는 이름
      • Client ID (X-NCP-APIGW-API-KEY-ID): 인증을 위해 ID의 역할을 하는 값. 헤더 또는 쿼리 스트링에 'X-NCP-APIGW-API-KEY-ID'로 입력
      • Client Secret (X-NCP-APIGW-API-KEY): 인증을 위해 SecretKey 비밀번호의 역할을 하는 값. 헤더 또는 쿼리 스트링에 'X-NCP-APIGW-API-KEY'로 입력
    • 서비스 환경
      • Web URL: Web SDK를 사용하기 위하여 필수로 입력해야 하는 값
      • Android 패키지 이름: Android SDK를 사용하기 위하여 필수로 입력해야 하는 값
      • iOS Bundle ID: iOS SDK를 사용하기 위하여 필수로 입력해야 하는 값

3. 서비스 선택

  1. 네이버 클라우드 플랫폼 콘솔에서 Services > AI·NAVER API > AI·NAVER API 메뉴를 차례대로 클릭해 주십시오.
  2. [Application 변경] 버튼을 클릭해 주십시오.
  3. Application이 선택되어 있는지 확인하고 선택되어 있지 않은 경우 선택해 주십시오.
주의

서비스를 선택하지 않는 경우 429(Quota Exceed) 오류가 발생하니 주의해 주십시오.

4. 호출

1.~3.의 내용을 토대로 API를 호출합니다. API 호출에 대한 결과는 성공과 실패로 구분할 수 있습니다. 응답에 성공한 경우 리턴된 결과를 확인합니다. 응답에 실패한 경우 오류 코드가 리턴됩니다. 리턴된 오류 코드를 확인하여 호출을 다시 시도해 주십시오.

성공

서비스 API 호출에 대한 응답 처리 방법은 각 서비스별 API 가이드의 응답 정보를 참고해 주십시오.

실패

호출에 실패하여 리턴되는 오류 코드에는 서비스 공통 오류 코드와 서비스별 오류 코드가 있습니다. 서비스별 오류 코드는 각 서비스별 API 가이드의 오류 코드를 참고해 주십시오.
공통 오류 코드의 경우 JSON 형식이 기본값(default)입니다. 공통 오류 코드별 메시지와 설명은 다음과 같습니다.

HTTP 상태 코드 오류 코드 오류 메시지 설명
400 100 Bad Request Exception protocol(https), endocing(UTF-8) 등 Request 오류
401 200 Authentication Failed 인증 실패
401 210 Permission Denied 권한 없음
404 300 Not Found Exception 권한 없음
429 400 Quota Exceeded Quota 초과
429 410 Throttle Limited Rate 초과
429 420 Rate Limited Rate 초과
413 430 Request Entity Too Large 요청 엔티티 크기 초과
503 500 Endpoint Error 엔드포인트 연결 오류
504 510 Endpoint Timeout 엔드포인트 연결 시간 초과
500 900 Unexpected Error 예외 처리가 안된 오류

공통 오류 코드 예시는 다음과 같습니다.

{
 "error":{
    "errorCode":"210",
    "message":"Permission Denied"
 }
 }

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