PythonでAPI呼び出す時のヘッダー、ボディの指定方法について

投稿日：2023年4月2日更新日：2023年11月5日

＜目次＞

(１) PythonでAPI呼び出す時のヘッダー、ボディの指定方法について
　 (１-１) 記事の概要
　 (１-２) ①「ヘッダー」の指定方法
　 (１-３) ②「ボディ」の指定方法
　 (１-４) ③「認証情報」の指定方法
　 (１-５) ④「パラメータ」の指定方法
　 (１-６) サンプルプログラム

(１) PythonでAPI呼び出す時のヘッダー、ボディの指定方法について

(１-１) 記事の概要

・PythonでHTTPリクエストを送る際の「ヘッダー」や「ボディ」や「認証情報」の指定の仕方について、サンプルプログラムも用いて紹介します。

・今回の内容は全般的にPythonのrequestsライブラリを使用する前提で記載しています。

・未インストールの方は、ターミナルを開いて「pip install requests」でインストールをお願いします。

（図１１１）

＞目次にもどる

(１-２) ①「ヘッダー」の指定方法

・requestsのget/postメソッドに「headers={“key”,”value”}」で指定。

・Dictionary型

・カンマ区切りで複数指定も可能

（例）

import requests
～中略～
response = requests.get(url, headers={"Content-Type":"text","User-Agent":"Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.0)"})

＞目次にもどる

(１-３) ②「ボディ」の指定方法

・requestsのget/postメソッドに「data={“key1”: “value1”}」で指定。

・Dictionary型or Byte型で指定。

・カンマ区切りで複数指定も可能。

（例）

import requests
～中略～
    body = {
        "key1": "value1",
        "key2": "value2"
    }
    data = json.dumps(body)
 
    response = requests.post(url, data=data)

＞目次にもどる

(１-４) ③「認証情報」の指定方法

(１-４-１) ●Basic認証

・requestsのget/postメソッドに「auth=([ユーザーID], [パスワード])」を指定。

（例）

import requests
～中略～
response = requests.get(url, auth=([ユーザーID], [パスワード]))

＞目次にもどる

(１-５) ④「パラメータ」の指定方法

利用者側（クライアント）から指定できるパラメータで、リクエストの内容を制御する時に使う。

URLの末尾に「?」を付加し、以降に[key]=[value]の形式で記載。

（例）include_localeとuserがクエリパラメータに相当

https://rainbowplanet.slack.com/api/users.info?include_locale=&user=

＞目次にもどる

(１-６) サンプルプログラム

Azure Logic AppsにHTTPリクエストを送り、DB更新を行うサンプルプログラムです。

Azure Logic Apps側で、リクエストのJSONボディを解析し、その内容をSQL ServerのテーブルにINSERTするように事前準備してあります（→★20230304_IT#0690_Azure_LogicApps_SQLServer_接続）

（図１２１）

（サンプルプログラム）

import json
import pandas as pd
import requests
 
def main():
 
    # APIのURL
    # →今回の場合はLogic AppsのＵＲＬを指定
    url = "https://prod-02.japaneast.logic.azure.com:443/workflows/8c49c44e1c614a8cb739a38705ceb0d8/triggers/manual/paths/invoke?api-version=2016-10-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=C6Nfm1Vm-63jH5k1a69pNOOa69mH4_o9np7qNCjyQ0o"
 
    # ヘッダー部
    headers = {
        "Content-Type":"application/json",
        "User-Agent":"Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.0)",
        #"Authorization":"Bearer "+"===TOKEN==="
    }
    
    # ボディ部
    # →テーブルにＩＮＳＥＲＴする内容をＪＳＯＮで指定
    body = {
        "crudType": "INSERT",
        "operationType": "joining",
        "employeeNo": "00000003",
        "lastName": "山田",
        "firstName": "五郎",
        "emailAddress": "yamada.taro.05@xxx.com",
        "joiningDate": "2022-01-01",
        "retirementDate": "NULL",
        "departmentCode": "444444"
    }
    data = json.dumps(body)
 
    # POSTリクエスト
    # 準備したURL、ヘッダー、ボディを指定して送る
    response = requests.post(url, headers=headers, data=data)
    
    # レスポンスの内容をtext形式で取得
    result = response.text
    print(result)
 
if __name__ == "__main__":
     main()