PythonでAPIを呼び出すサンプルプログラムをご紹介

（構文）

# API呼び出しに必要なパッケージのimport
import requests
# getメソッドでURLに対してGETリクエストを送る
response = requests.get("[APIのURL]")

＞目次にもどる

事前準備として、APIを呼び出すために必要な「request」ライブラリを下記のpipコマンドでインストールします。

> pip install requests --users

（図１１１）

ちなみに「–users」はpipによるインストールをユーザーのホームディレクトリに対して行うように指示するオプションです。通常pipによるインストールは、システムディレクトリ（例：/usr/local/lib/python3.9）に対して実施しますが、これには「管理者権限」が必要となります。

 

「–users」を付与する事で、そういった管理者権限を必要としない、ユーザー自身に閉じたインストールを実施できます。

＞目次にもどる

上記構文に沿って、サンプルプログラムで最もシンプルなケースを疎通してみます。

 

（サンプルプログラム）

# API呼び出しに必要なパッケージのimport
import requests
# getメソッドでURLに対してGETリクエストを送る
response = requests.get("https://zipcloud.ibsnet.co.jp/api/search?zipcode=221-0866")
# レスポンスをテキスト形式に変換
result = response.text
# 結果をコンソール出力
print(result)

PS C:\dev\Python\ApiTest> & C:/Python310/python.exe c:/dev/Python/ApiTest/__init__.py
{
        "message": null,
        "results": [
                {
                        "address1": "神奈川県",
                        "address2": "横浜市神奈川区",
                        "address3": "羽沢南",
                        "kana1": "ｶﾅｶﾞﾜｹﾝ",
                        "kana2": "ﾖｺﾊﾏｼｶﾅｶﾞﾜｸ",
                        "kana3": "ﾊｻﾞﾜﾐﾅﾐ",
                        "prefcode": "14",
                        "zipcode": "2210866"
                }
        ],
        "status": 200
}
PS C:\dev\Python\ApiTest>

（図１１２）

＞目次にもどる

次にBasic認証がある場合のAPI呼び出しの例をご紹介します。

 

Basic認証は、いわゆる「ユーザーID／パスワード」で認証を行う方式ですが、この「ユーザーID／パスワード」の情報はHTTPリクエストのヘッダーに乗せて送る形になります。

 

先程のプログラムと比較して、getメソッドの引数が追加になっています（ID／Passwordが追加）

 

（構文）ポイント

    # 先程と異なり、第2引数でBasic認証に必要な「auth=(user_id,password)」を与えています。
    response = requests.get(url, auth=(user_id, password))

import requests
import os
from requests.auth import HTTPBasicAuth
from dotenv import load_dotenv
from pathlib import Path

# このPythonファイルがあるパスを取得
file_path = Path(__file__).parent
# 環境変数用のファイル「.env」のパスを定義
env_path = file_path/'.env'
# 環境変数用のファイル「.env」をロードする
load_dotenv(dotenv_path=env_path)

def main():
    # APIのURL
    url = '[APIのURL]'
    # Basic認証で必要なID/Password
    user_id = os.environ['USER_ID']
    password = os.environ['PASSWORD']
    # getメソッドでURLに対してGETリクエストを送る
    # ▲先程と異なり、第2引数でBasic認証に必要な「auth=(user_id,password)」を与えています。
    response = requests.get(url, auth=(user_id, password))
    # レスポンスの内容をtext形式で取得
    result = response.text
    # 結果をコンソール出力
    print(result)

if __name__ == "__main__":
    main()

（図１１３）Basic認証ありのサンプル

（※注）

上記プログラムとは別に、同じ階層に環境変数を定義する用の「.env」ファイルを用意して、環境変数をそのファイルに定義する必要があります。また、それをロードするために「dotenv」ライブラリをpipでインストールする必要もあります。

 

（例）「.env」の記述例

＞目次にもどる