네이버 검색 API 사용하여 출력하기

네이버에서 공식적으로 서비스 API를 공유하고 있는데, 종류도 다양하다.

우린 그중에서, 영화 검색 API를 사용할 것이다.

 

검색 API?

검색 API는 네이버 검색 결과를 뉴스, 백과사전, 블로그, 쇼핑, 영화, 웹 문서, 전문정보, 지식iN, 책, 카페글 등 분야별로 볼 수 있는 API

 

영화 검색은 검색 API를 사용해 네이버 검색의 영화 검색 결과를 반환하는 RESTful API입니다. 영화 검색 결과를 XML 형식 또는 JSON 형식으로 반환하여 사용한다.

 

RESTful API?

RESTful API는 두 컴퓨터 시스템이 인터넷을 통해 정보를 안전하게 교환하기 위해 사용하는 인터페이스이다.

 

API (애플리케이션 프로그래밍 인터페이스)?

API는 다른 소프트웨어 시스템과 통신하기 위해 따라야 하는 규칙을 정의한다.

개발자는 다른 애플리케이션이 프로그래밍 방식으로 애플리케이션과 통신할 수 있도록 API를 표시하거나 생성한다.

 

REST(Representational State Transfer)?

REST는 API 작동 방식에 대한 조건을 부과하는 소프트웨어 아키텍처이다.

REST는 처음에 인터넷과 같은 복잡한 네트워크에서 통신을 관리하기 위한 지침으로 만들어졌다.

 

본격적으로 네이버에서 사용하고 있는 서비스 API, 영화 검색 API 사용하여 출력해보자.

 

사전 준비

• 네이버 개발자 센터 회원가입
• 새로운 애플리케이션 등록 (애플리케이션 이름, 사용 API: 검색 선택, 환경: Android, IOS 설정, 패키지 이름 입력)
• Secret ID, Password 기억하기

 

요청 URL

• https://openapi.naver.com/v1/search/movie.json

 

우리는 결과값 반환 형식을 xml이 아닌 json으로 설정하였다.

 

xml, json이 무엇일까?

• xml: W3C에서 개발된, 다른 특수한 목적을 갖는 마크업 언어를 만드는데 사용하도록 권장하는 다목적 마크업 언어
• json: Javascript 객체 문법으로 구조화된 데이터를 표현하기 위한 문자 기반의 표준 포맷

 

차이점

xml: 텍스트 데이터에 태그를 추가하여 트리 구조로 데이터를 표현한다.

<person>
  <name>John</name>
  <age>30</age>
  <city>New York</city>
</person>

 

json: 키-값 쌍의 집합으로 데이터를 표현한다.

{
  "person": {
    "name": "John",
    "age": 30,
    "city": "New York"
  }
}

 

위에 설명한 요청 URL를 클릭하여 들어가보자!

에러 메시지 발생

 

이유는 필수 파라미터의 값을 안 넣었기 때문이다.

 

위에서 필수 파라미터가 무엇인지 네이버가 아주 친절하게 말해준다.

 

필수 파라미터를 포함한 요청 URL

• https://openapi.naver.com/v1/search/movie.json?query=플러터

 

어? 이번에는 위에 메시지가 아닌, 다른 에러 메시지가 발생했다.

다른 에러 메시지 발생

 

이유는 Client ID, Password가 존재하지 않기 때문에 인증에 실패한 것이다.

 

아까전에 Secret ID, Password를 기억하라는 이유가 해당 에러 메시지를 해결하기 위해서 기억하라고 한 것이다.

 

포스트맨 사용하여 API를 출력해보자.

 

포스트맨?

포스트맨은 개발자들이 API를 디자인하고 빌드하고 테스트하고 반복하기 위한 API 플랫폼이다.

 

설치 과정은 생략하고, API가 정상적으로 출력되는지, 테스트해보자.

 

Send 클릭하면 당연히 인증에 실패했다고 에러 메시지가 나올 것이다.

Headers 클릭하여 ID와 Password를 입력하면 된다.

 

키를 아래와 같이 입력 후 값은 발급 받은 ID와 Password를 입력하면 된다.

 

두근, send를 클릭하여 결과를 한번 확인해보자.

 

정상적으로 값을 받아온 걸 두 눈으로 직접 확인할 수 있다!

 

다음 시간에는 플러터를 이용하여 값을 실제로 가져와보겠다.