API (with 네이버 오픈 API)

목차

• API (Application Programming Interface)
• API 사용 예시
  • API 키 발급
  • API 사용법 확인
  • API 사용

API (Application Programming Interface)

• API의 정확한 정의는 다음과 같습니다.
  • API(Application Programming Interface)는 소프트웨어 또는 애플리케이션 간의 상호작용을 가능하게 하는 규칙, 프로토콜 및 도구의 집합입니다.
• 너무 어려운 표현 방법일 수 있기 때문에 조금 더 쉽게 표현하면 다음과 같습니다.
  • API는 다른 소프트웨어나 프로그램과 대화할 수 있게 해주는 도구라고 생각할 수 있습니다.
  • API가 없다면, 각각의 프로그램은 서로 이해할 수 없는 외국어를 사용하는 것처럼 사로 다른 언어를 사용하기 때문에 상호작용이 어렵습니다. 
• 예시를 통해 조금더 이해를 쉽게 해 보도록 하겠습니다.
  • 식당 예시 
    • API를 사용하는 것은 식당에서 종업원을 통해 주문하는 것과 비슷합니다.
    • 메뉴에는 식당에서 제공하는 다양한 음식들이 있습니다. 손님은 종업원을 통해 원하는 음식을 주문합니다.
    • 여기서 메뉴는 API가 제공하는 서비스나 데이터의 목록이고, 종업원은 그 요청을 주방(서버)에 전달하는 API의 역할을 합니다. 주방은 주문받은 음식을 준비하고 종업원을 통해 손님에게 전달합니다.
    • 이 과정에서 손님은 주방의 복잡한 과정을 거치지 않고도 원하는 결과를 얻을 수 있습니다.
  • 실제 API 예시
    • 개발자가 날씨 정보 API를 사용하여 최신 날씨 데이터를 가져올 수 있습니다.
    • 개발자는 이 API를 통해 특정 도시의 날씨 정보를 요청하고, API는 해당 요청을 처리하여 필요한 데이터를 앱으로 다시 보냅니다.
    • 이렇게 하면 앱 개발자는 날씨 데이터를 수집하고 분석하는 복잡한 과정을 거치지 않고도 사용자에게 필요한 정보를 제공할 수 있습니다.
  • 이처럼 API는 서로 다른 소프트웨어가 서로 '대화'하고 협력할 수 있게 해주는 중요한 도구입니다.

API 사용 예시

• API를 실제로 사용해보면서 API에 대해 조금 더 자세히 이해하고, 사용법까지 익혀보도록 하겠습니다.
  
  • 네이버에서 제공하는 오픈 API를 사용하도록 하겠습니다.

API 키 발급

• API를 사용하기 위해서는 API 키나 토큰을 발급받아야합니다.
  • API 키나 토큰을 발급받아야 하는 이유
    • 보안 : API 키나 토큰을 통해 API 제공자는 누가 자신의 서비스를 사용하는지 알 수 있고, API와 데이터를 보호할 수 있습니다. 
    • 접근 제어 : API 키나 토큰을 통해 특정 사용자에게 특정 API 기능이나 데이터에 대한 접근을 허용하게 해 줄 수 있습니다. 이를 통해 API 제공자는 자신의 서비스를 더 잘 관리하고 제어할 수 있습니다.
    • 제한적 사용 : 많은 API 서비스는 사용량 제한이나 할당량을 두어 API의 과도한 사용을 방지합니다. 또한 유료 API 서비스의 경우, API 키를 통해 사용량을 기준으로 과금을 진행할 수 있습니다.
  • 발급 과정
    • 네이버 메인 페이지에서 제일 하단으로 내려보게 되면 네이버 개발자 센터가 있습니다. 이를 통해 네이버 개발자 센터에 접속합니다.
    • 그 후 상단 Application → 애플리케이션 등록을 클릭합니다.
    • 애플리케이션 등록 창에서 원하는 애플리케이션 이름과 사용 API를 선택해 줍니다. (여기서는 검색 API를 예시로 들어보겠습니다.)
    • 서비스 환경을 추가해 줍니다. (여기서는 WEB 설정을 진행하도록 하겠습니다. 웹 서비스 URL은 로컬에서만 접근할 것이기 때문에 http://localhost:8000로 설정해 주도록 하겠습니다.)
      
      • 
      • 만약 도메인을 사용할 경우 그 도메인을 웹 서비스 URL에 추가해 주면 됩니다.
      • 여기서 서비스 환경이라는 것은 이 오픈 API를 어떤 환경에서 공개할거냐, 즉 URL을 입력하라는 것입니다. 만약 로컬에서만 공개해서 사용할것이면 위와 같이 작성하면 됩니다. 하지만 나중에 배포를 할경우에는 내부IP와 내부 포트 번호를 외부 IP주소의 외부 포트번호에 포트포워딩을 진행한 뒤, 외부에서 접속 가능한 URL을 작성해주어야합니다. 
    • 등록을 완료하면 Client ID와 Client Secret이 생겨난 것을 확인할 수 있습니다.
      • 이 두 정보는 비밀번호와 같은 것이기 때문에 절대 공개해서는 안됩니다.
      • 추후에 기억이 안 날 경우 네이버 개발자 센터  Application → 내 애플리케이션에서 해당 Application을 선택하면 확인이 가능합니다.

API 사용법 확인

• API는 종업원, API가 제공하는 서비스나 데이터의 목록이 메뉴라고 했습니다. 그렇다면 메뉴를 확인하고 종업원에게 어떤 메뉴를 주문할지, 현금인지 카드인지 , 주류를 구매한다면 신분증 등 다양한 필요한 정보를 제시해주어야 합니다. 이런 필요한 내용은 종업원이 안내를 해줄 것입니다. 
• 이와 같이 필요한 정보와 사용법은 API Documents에 나와있습니다. 이를 통해 개발자는 API를 손쉽게 이용할 수 있습니다.
• 현재 검색 API를 사용하고 있기 때문에 검색에 관한 API Documents를 살펴보도록 하겠습니다.
  • 네이버 개발자 센터 Documents → 서비스 API → 검색에서 검색에 관한 다양한 사용법을 확인할 수 있습니다.
  • 

API 사용

• 코드를 통해서 확인해 볼 수 도 있지만 조금 더 쉬운 방법인 Postman을 사용해 보도록 하겠습니다.
  • Postman 설치는 검색을 통해 손쉽게 가능합니다.
• Postman 이 실행되면 + 버튼을 통해 Untitled Request를 생성합니다.
• 그 후 API Documents를 참고하여 HTTP 메서드 방식, url, 필요한 파라미터를 채워주고 Postman Send를 진행합니다.
  • API Documents (뉴스 검색) 
    • 요청 URL
      • 
    • HTTP 메서드
      • 
    • 파라미터
      • 
    • 예시
      • 
  • Postman 값 채워주기
    • 
    • 추가적으로 Header에 Client-Id와 Client-Secret을 채워주고 Send를 누르면 정상 작동하는 것을 확인할 수 있습니다.