次の例は、Python requests を使用して API を呼び出す方法を示しています。
API キーを使用して認証を行います。まず、関心のある API のメソッドを選択します。
試してみるには:
- Python
requestsライブラリをインストールします。コマンドラインから:pip install requests - 次の Python プログラムをコンピュータに保存し、
example.pyという名前を付けます。 - サンプル JSON をダウンロードする
。
名前を挙げる
example_request.json - コマンドラインから例を実行します（
python example.py）。
# example.py
import json
import requests
def run_example():
"""Calls the OR API to solve a shift scheduling problem."""
# Endpoint for the workforce scheduling solver in the OR API.
end_point = "https://optimization.googleapis.com/v1/"
# Read the API Key from a JSON file with the format:
# {"key": "your_api_key"}
with open("credentials.json") as f:
credentials = json.load(f)
api_key = credentials["key"]
# Load the JSON file with the request.
with open("example_request.json", "r") as f:
json_request = json.load(f)
# Call the API post method.
response = requests.post(f"{end_point}?key={api_key}", json=json_request)
# Process the response.
if response.ok:
solution = json.loads(response.content)
with open("example_response.json", "w") as f:
json.dump(solution, f, indent=2)
print(solution)
else:
error = json.loads(response.content)["error"]
print(f'Status code {error["code"]}: {error["message"]}')
if __name__ == "__main__":
run_example()
期限の設定方法
期限により、API の呼び出しに要する最大経過時間が決まります。 ユーザーはクライアントとサーバーの両方の期限を設定できます。OR API のコンテキストでは、 最も有用なタイムスタンプは、バックエンド サーバーへの リクエストを受け取って、基礎となるソルバーを実行し、 レスポンスが返されます。対照的に、クライアントの期限は、リソースへの最大応答時間を クライアント アプリケーション（OR API を呼び出すアプリケーション）は、 応答を待ってからタイムアウトします。
次のコード スニペットでは、
リクエストのセッション ヘッダー。クライアントの期限は 60 秒に設定されています。「
サーバーの期限は、クライアントの期限よりも短くする必要があります。
オーバーヘッドが増加します。ここでは、サーバーのデッドラインをクライアントのデッドラインの 95% に設定していますが、これはアプリケーションによって異なる場合があります。session.post(...) 呼び出しをクリーンにする目的で、API キーもセッション ヘッダーに移動されています。
# Call the API post method.
session = requests.Session()
client_deadline_seconds = 60
server_deadline_seconds = 0.95 * client_deadline_seconds
session.headers = {
"Content-Type": "application/json",
"Connection": "keep-alive",
"Keep-Alive": f"timeout={client_deadline_seconds}, max=1",
"X-Server-Timeout": f"{server_deadline_seconds}",
"X-Goog-Api-Key": api_key,
}
response = session.post(end_point, json=json_request, timeout=client_deadline_seconds)