Requests 라이브러리로 베이직 인증 API 호출하기

Requests 라이브러리로 베이직 인증 API 호출하기

Python
Flask
Requests 라이브러리로 베이직 인증 API 호출하기
Author

gabriel yang

Published

October 8, 2024


Python Requests 라이브러리로 베이직 인증 API 호출하기

API를 호출할 때 인증이 필요한 경우가 많습니다. 이 중에서 가장 간단한 인증 방식 중 하나는 베이직 인증 (Basic Authentication)입니다. 베이직 인증은 사용자의 아이디와 비밀번호를 Base64로 인코딩하여 서버에 전송하는 방식입니다. Python에서는 requests 라이브러리를 사용해 쉽게 베이직 인증을 처리할 수 있습니다. 이번 글에서는 requests 라이브러리를 사용하여 베이직 인증을 적용한 API를 호출하는 방법을 단계별로 설명하겠습니다.

1. requests 라이브러리 설치하기

우선, Python 환경에 requests 라이브러리가 설치되어 있는지 확인합니다. 설치되어 있지 않다면 아래 명령어를 사용해 설치할 수 있습니다.

pip install requests

requests는 Python에서 가장 널리 사용되는 HTTP 라이브러리로, API 호출이나 웹 요청을 쉽게 처리할 수 있는 도구입니다.

2. 베이직 인증 API 구조 이해하기

베이직 인증 방식에서는 API 호출 시 요청의 Authorization 헤더에 사용자의 자격 증명을 포함해야 합니다. 베이직 인증 헤더는 다음과 같은 형식을 따릅니다:

Authorization: Basic <Base64로 인코딩된 사용자명:비밀번호>

하지만 requests 라이브러리를 사용하면 이 과정을 수동으로 처리할 필요가 없습니다. requests는 자동으로 자격 증명을 인코딩하고 헤더를 생성해줍니다.

3. requests를 사용한 베이직 인증 API 호출

다음은 requests 라이브러리로 베이직 인증을 적용한 API를 호출하는 간단한 예제입니다.

import requests
from requests.auth import HTTPBasicAuth

# API 엔드포인트 URL
url = "https://api.example.com/data"

# 사용자명과 비밀번호
username = "your_username"
password = "your_password"

# 베이직 인증을 사용한 GET 요청
response = requests.get(url, auth=HTTPBasicAuth(username, password))

# 응답 결과 확인
if response.status_code == 200:
    print("API 호출 성공!")
    print(response.json())  # JSON 응답을 출력
else:
    print(f"API 호출 실패. 상태 코드: {response.status_code}")

코드 설명:

  • auth=HTTPBasicAuth(username, password):
    • HTTPBasicAuth 클래스를 사용해 사용자명과 비밀번호를 전달합니다.
    • 이 클래스는 요청을 보내기 전에 자동으로 Authorization 헤더를 생성합니다.
  • response.status_code:
    • API 호출의 성공 여부를 확인하기 위해 HTTP 상태 코드를 검사합니다. 성공적인 응답은 보통 200번대의 상태 코드를 반환합니다.
  • response.json():
    • 응답이 JSON 형식이라면 json() 메서드를 사용해 파이썬 딕셔너리로 변환할 수 있습니다.

4. POST 요청으로 데이터 전송하기

베이직 인증을 사용할 때 GET 요청뿐만 아니라 POST 요청으로 데이터를 전송할 수도 있습니다. 예시로, POST 요청을 통해 데이터를 서버로 전송하는 방법을 살펴보겠습니다.

import requests
from requests.auth import HTTPBasicAuth

# API 엔드포인트 URL
url = "https://api.example.com/data"

# 사용자명과 비밀번호
username = "your_username"
password = "your_password"

# 전송할 데이터
data = {
    "key1": "value1",
    "key2": "value2"
}

# 베이직 인증을 사용한 POST 요청
response = requests.post(url, json=data, auth=HTTPBasicAuth(username, password))

# 응답 결과 확인
if response.status_code == 201:
    print("데이터 전송 성공!")
    print(response.json())  # 서버로부터의 응답 출력
else:
    print(f"데이터 전송 실패. 상태 코드: {response.status_code}")

코드 설명:

  • requests.post():
    • POST 요청을 사용하여 서버에 데이터를 전송합니다. 데이터를 json 인수로 전달하면 요청 본문(body)에 JSON 형식으로 자동 변환됩니다.
  • response.status_code == 201:
    • POST 요청이 성공하면 201 상태 코드(Created)가 반환되는 경우가 많습니다.

5. 예외 처리

API 호출 중에 발생할 수 있는 다양한 예외 상황을 처리하기 위해, try-except 블록을 사용하는 것이 좋습니다. 예외 처리를 통해 네트워크 오류나 잘못된 응답을 효과적으로 관리할 수 있습니다.

import requests
from requests.auth import HTTPBasicAuth

url = "https://api.example.com/data"
username = "your_username"
password = "your_password"

try:
    response = requests.get(url, auth=HTTPBasicAuth(username, password))
    response.raise_for_status()  # 응답 코드가 4xx 또는 5xx인 경우 예외 발생
    print("API 호출 성공!")
    print(response.json())
except requests.exceptions.HTTPError as http_err:
    print(f"HTTP 오류 발생: {http_err}")
except requests.exceptions.ConnectionError as conn_err:
    print(f"연결 오류 발생: {conn_err}")
except requests.exceptions.Timeout as timeout_err:
    print(f"타임아웃 오류 발생: {timeout_err}")
except requests.exceptions.RequestException as req_err:
    print(f"요청 오류 발생: {req_err}")

코드 설명:

  • response.raise_for_status():
    • 응답 코드가 4xx 또는 5xx일 경우 예외를 발생시켜 오류를 처리합니다.
  • except 블록:
    • 다양한 예외 상황을 처리할 수 있도록 여러 가지 예외를 구분하여 처리합니다.