網路設計範例

以下範例說明如何使用 Python requests 呼叫 API 使用 API 金鑰進行驗證。使用方法：

• 安裝 Python requests 程式庫。使用指令列：pip install requests。
• 將下列 Python 程式儲存到電腦，命名為 example.py。
• 將 example_request.json 檔案與 (這是 JSON 要求範例)。
• 在與您帳戶相同的目錄中建立 credentials.json 檔案 計畫，與 {"key": "your_api_key"} 合作
• 從指令列執行範例：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/shipping:designShippingNetwork"
    
    # 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% 但實際期限會因應用程式而異。請注意，API 鍵也移至工作階段標頭，以便發出 session.post(...) 呼叫 更簡潔。

# 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)