REST API
REpresentational State Transfer
アドレス可能性
ステートレス性
接続性
統一インターフェース
必要情報
| APIに接続するための情報 API登録時に入手 | </> APIエンドポイント(接続用URL) <key> APIキー |
| APIに送信する情報 公式ドキュメントを参照 | <HTTP> メソッド <header> APIキー、データの種類 <body> 送受信する情報(JSON形式) |
JSON
Java Script Object Notation
リクエストの送信・レスポンスに使用されるフォーマット
辞書型{“key”:”value”} 必ずダブルクォーテーションで囲う
[
{"id":"1","name":"ABC"}
{"id":"2","name":"DEF"}
]
HTTPメソッド
GET
WebページやAPIからのデータ取得。
cssファイルやJavaScriptファイルといったデータ取得
POST
フォームからデータを送信
アカウントの新規作成
新規データを作成
PUT
既存データの編集
アカウントやツイート情報
SNS上でのコメントなどを編集
DELETE
データの削除
アカウントやブログ記事などのデータを削除
Pythonコード内 APIキー読み込み
セキュリティの観点から、別.txtファイルからapi-keyを読み取る
# openai
import os
with open('./api_key.txt', 'r') as f:
key = f.read()
os.environ["OPENAI_API_KEY"] = key
# Google API
with open("./api_key/api-key.txt","r") as f:
google_api_key = f.read()
os.environ["GOOGLE_API_KEY"] = google_api_key
# Google Custom Search Engine
with open("./api_key/api-key.txt","r") as f:
cse_id = f.read()
os.environ["GOOGLE_CSE_ID"] = cse_id