APIのベーシック認証仕組みから実装まで

2024年5月17日2024年8月19日

APIベーシック認証とは

APIベーシック認証は、簡単かつ広く使用される認証方式の一つです。

特にサンプルコードや検証環境など、セキュリティの厳しい設定が不要な場合に利用されます

この方法では、ユーザ名とパスワードをBase64符号化してHTTPヘッダに載せて送信します。

HTTPヘッダを用いた認証方法

APIベーシック認証の基本的な流れは以下の通りです。

クライアントがリクエストを送信。
サーバが“401 Unauthorized”レスポンスを返し、クライアントに認証情報を求める。
クライアントがユーザ名とパスワードをBase64エンコードしてHTTPヘッダにセットし、再度リクエスト。
サーバが認証情報を検証、リソースを提供。

実装例 – cURLを使用したベーシック認証

コマンドラインツールcURLを使用して、APIベーシック認証のリクエストを送信する方法をご紹介します。

curl -u 'username:password' https://api.example.com/resource

ここで、’username’と’password’は実際のユーザ名とパスワードに置き換えてください。

実装例 – Pythonを使用したベーシック認証

PythonでAPIベーシック認証を行うコード例も示します。

以下のコードを使用すると、自動でHTTPヘッダに認証情報が追加されます。

import requests

url = "https://api.example.com/resource"
response = requests.get(url, auth=('username', 'password'))

if response.status_code == 200:
    print("認証成功")
    print(response.json())
else:
    print("認証失敗")

ここでも、’username’と’password’を置き換えて実行してください。

実装例 – JavaScript（Axios）を使用したベーシック認証

JavaScriptにおいて、Axiosライブラリを使用したベーシック認証の例を示します。

const axios = require('axios');

const username = 'username';
const password = 'password';
const url = 'https://api.example.com/resource';

axios.get(url, {
  auth: {
    username: username,
    password: password
  }
})
.then(response => {
  console.log("認証成功:", response.data);
})
.catch(error => {
  console.log("認証失敗:", error);
});

JavaScriptでも、適切なユーザ名とパスワードに置き換える必要があります。