नेटवर्क डिज़ाइन का उदाहरण

इस उदाहरण में, Python requests की मदद से एपीआई को कॉल करने का तरीका बताया गया है इस लाइब्रेरी में, पुष्टि करने के लिए एपीआई पासकोड का इस्तेमाल किया जाता है. इसका इस्तेमाल करने के लिए:

• 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()

आखिरी तारीख कैसे सेट करें?

समयसीमा से यह तय होता है कि एपीआई को कॉल करने में ज़्यादा से ज़्यादा कितना समय लगेगा. उपयोगकर्ता, क्लाइंट और सर्वर, दोनों के लिए समयसीमाएं सेट कर सकता है. OR एपीआई के संदर्भ में, सर्वर की समयसीमा ज़्यादा काम की है, क्योंकि इससे बैकएंड सर्वर को यह पता चलता है कि अनुरोध पाने, बुनियादी सॉल्वर को चलाने, और जवाब. वहीं दूसरी ओर, क्लाइंट की डेडलाइन से पहले, क्लाइंट ऐप्लिकेशन (यानी कि OR एपीआई को कॉल करने वाला ऐप्लिकेशन) समय खत्म होने से पहले, जवाब का इंतज़ार करें.

नीचे दिया गया कोड स्निपेट, अनुरोध के सेशन हेडर का इस्तेमाल करें. क्लाइंट के लिए काम करने की समयसीमा 60 सेकंड पर सेट है. कम्यूनिकेशन ओवरहेड का हिसाब लगाने के लिए, सर्वर की समयसीमा, क्लाइंट की समयसीमा से कम होनी चाहिए. यहां हमने सर्वर की समयसीमा को 95% क्लाइंट के लिए तय किया है लेकिन आवेदन के आधार पर यह अलग-अलग हो सकती है. ध्यान दें कि एपीआई 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)