Cato API জন্য একটি পাইথন স্ক্রিপ্ট ব্যাখ্যা করা হচ্ছে

এই নমুনা প্রোগ্রামটি ছোট এবং এটি কোনও সিদ্ধান্ত গ্রহণের লজিক বা ক্রিয়া পুনরাবৃত্তির কোড অন্তর্ভুক্ত করে না।  কোডের কিছু লাইন একটি লাইনে মিশ্রিত করে এটি আরও ছোট রাখা যেতে পারত।  প্রকৃতপক্ষে কি ঘটছে তা ব্যাখ্যা করা সহজ করার জন্য অতিরিক্ত কোড লাইন অন্তর্ভুক্ত করা হয়েছে।

# পাইথন লাইব্রেরি কোড ইনপোর্ট করুন
import os
import urllib.request
import ssl
import json

# পরিবেশতথ্য থেকে Cato API কী প্রাপ্ত করুন
cato_api_key = os.getenv("CATO_API_KEY")

# পাঠানোর জন্য GraphQL অনুরোধ তৈরি করুন
get_total_admins = '''{
    admins (accountID: 12345) {
        total        
    }
}'''
graphql_query = {'query': get_total_admins}

# HTTP অনুরোধ নির্মাণ করুন
cato_api_url = "https://api.catonetworks.com/api/v1/graphql2"
headers = {'x-api-key': cato_api_key,
           'Content-Type':'application/json'}
unverified_ctx = ssl._create_unverified_context()
json_post = json.dumps(graphql_query)
json_post_encoded = json_post.encode()
request = urllib.request.Request(url=cato_api_url, data=json_post_encoded, headers=headers)

# অনুরোধ প্রেরণ করুন এবং প্রতিক্রিয়াটি পাইথন অভিধানে রূপান্তর করুন
response = urllib.request.urlopen(request, context=unverified_ctx, timeout=30)
json_response_encoded = response.read()
json_response = json_response_encoded.decode()
get_admins_total_result = json.loads(json_response)

# ফেরত প্রাপ্ত ডেটা থেকে মোট নির্ধারণ করুন এবং এটি মুদ্রণ করুন
total = get_admins_total_result['data']['admins']['total']
print('আপনার অ্যাকাউন্টের সাথে সংজ্ঞায়িত প্রশাসকদের মোট সংখ্যা হল: {}'.format(total))

নীচে প্রদত্ত চিত্রটি দেখায় প্রোগ্রামটি চালানোর সময় কি ঘটছে তার ক্রম:

উদাহরণ প্রোগ্রামের জন্য পাইথন ব্যবহার করার একটি কারণ হল সমৃদ্ধ লাইব্রেরির সেটের প্রাপ্যতা।  এই লাইব্রেরিগুলি ফাংশন এবং বস্তু প্রদান করে যা বিস্তৃত কাজগুলি সামলাতে পারে।  প্রতিটি ইনপোর্ট করা লাইব্রেরির মাধ্যমে আমরা যাব এবং কেন এটি প্রয়োজন তা ব্যাখ্যা করার জন্য নোট প্রদান করব।

import os

import urllib.request

import ssl

import json

এই লাইনের কোডটি পরিবেশ চলিছিত্র থেকে API কী পড়তে এবং একটি চলিছিত্রে বরাদ্দ করতে getenv লাইব্রেরি ফাংশনটি ব্যবহার করে।

cato_api_key = os.getenv("CATO_API_KEY")

Cato GraphQL সার্ভার একটি HTTP হেডারে এই কী পেতে প্রত্যাশা করে।  JSON ডকুমেন্টে কী প্রদান করা হয় না কারণ GraphQL নির্দিষ্টকরণে প্রমাণীকরণ মান হিসাবে অন্তর্ভুক্ত নয়।  JSON ডকুমেন্টে প্রমাণীকরণ অন্তর্ভুক্ত করা নির্দিষ্টকরণের লঙ্ঘন হবে।  Cato ম্যানেজমেন্ট অ্যাপ্লিকেশন মাধ্যমে Cato API কী তৈরি করা হয়।  API কী তৈরি করার আরও তথ্যের জন্য দেখুন Cato API-এর জন্য API কী তৈরি করা।

কোডের পরবর্তি কয়েকটি লাইনে একটি পাইথন ডিরেক্টরি তৈরি করা হয় যা একটি কী/মান যুগল অন্তর্ভুক্ত করে।  নিবন্ধটির মান একটি পাইথন বহু-লাইন স্ট্রিং ব্যবহার করে তৈরি করা হয় যা গ্রাফিকQL সার্ভারে পাঠানো হবে এমন অনুরোধ সংজ্ঞায়িত করে।

get_total_admins = '''{
    admins (accountID: 12345) {
        total    
    }
}'''
graphql_query = {'query': get_total_admins}

Cato GraphQL সার্ভার এই স্ট্রিংটি দ্বারা নির্দেশ করবে: get_total_admins ফাংশনটি সম্পাদন করুন, এটিতে দুটি যুক্তি পাস করে (accountID এবং type) এবং শুধুমাত্র সংস্থার "মোট" সংখ্যা ফেরত দেয়।  অথবা সরাসরি বলা যায়, "উদাহরণ অ্যাকাউন্ট # 12345 এর জন্য সংজ্ঞায়িত প্রশাসকদের মোট সংখ্যা ফেরত দেয়।"  admins API কলের এই নির্দিষ্ট উদাহরণটি গ্রাফিকএল API-এর একটি গুরুত্বপূর্ণ সুবিধা চিত্রিত করে।

বাস্তবতা হল, admins কলটি অনেক বেশি ডেটা ফেরত দিতে পারে।  উদাহরণস্বরূপ, কোনও অ্যাপ্লিকেশনকে admins প্রতিটি প্রশাসকের বিবরণ ফেরত দিতে অনুরোধ করতে পারে।  তবে, এই অ্যাপ্লিকেশনটির শুধুমাত্র প্রশাসকদের মোট সংখ্যা জানতে হবে।  GraphQL-এর এই বৈশিষ্ট্যটি "অতিরিক্ত সংগ্রহ" হিসেবে পরিচিত বিষয়টিকে এড়িয়ে যায় এবং অ্যাপ্লিকেশনটি বাস্তবায়ন করার জন্য প্রয়োজনীয় কোডকে উল্লেখযোগ্যভাবে সহজ করতে পারে।

প্রোগ্রামের এই অংশে একটি অনুরোধ অবজেক্ট কনস্ট্রাক্ট করা হয়।  এই বস্তুটি HTTPS ব্যবহার করে গ্রাফিকএল সার্ভারে API কল প্রেরণের জন্য ব্যবহার করা হবে। এই অনুরোধ অবজেক্টটিকে এমন তথ্য প্রয়োজন যা অন্যান্য বেশ কয়েকটি অবজেক্ট দ্বারা সরবরাহ করতে হবে যা প্রথমে নির্মিত হতে হবে।   প্রথমে একটি সাধারণ স্ট্রিং অবজেক্ট তৈরি করা হয় যাতে GraphQL সার্ভারের URL থাকে যেটি অনুরোধ অবজেক্টটি কল প্রেরণ করবে।

cato_api_url = "https://api.catonetworks.com/api/v1/graphql2"

পরবর্তীতে দুটি HTTP হেডার সংজ্ঞায়িত করে একটি অভিধান তৈরি করা হয়।  এই হেডারগুলি অনুরোধ অবজেক্ট দ্বারা একটি HTTP POST অনুরোধ নির্মাণ করতে ব্যবহৃত হয় যা GraphQL সার্ভার গ্রহণ করবে।  এই হেডারগুলি ছাড়া HTTP POST অনুরোধগুলি সার্ভার দ্বারা প্রত্যাখ্যাত হবে।

headers = {'x-api-key': cato_api_key,           
           'Content-Type':'application/json'}

কোডের পরবর্তী লাইনটি একটি SSL প্রসঙ্গ অবজেক্ট তৈরি করে। পাইথন এই অবজেক্টটি ব্যবহার করে নির্ধারণ করে কিভাবে এটি HTTP অনুরোধগুলি এনক্রিপ্ট করবে এবং ট্রান্সপোর্ট লেভেল সিকিউরিটি (TLS) ব্যবহার করে পাঠাবে। এখানে একটি SSL প্রসঙ্গ অবজেক্ট তৈরি করা হচ্ছে যা শংসাপত্র যাচাই করে না। উপরে তুলনা TLS পরিদর্শনে নেটওয়ার্কে শংসাপত্রের ত্রুটি এড়ানোর জন্য এটি করা হয়েছে।

unverified_ctx = ssl._create_unverified_context()

কোডের পরবর্তী দুটি লাইন Cato API কল ধারণকারী পাইথন অভিধানকে একটি স্ট্রিংয়ে রূপান্তর করে এবং সেই স্ট্রিংটিকে বাইটে এনকোড করে।  স্ট্রিংটিকে নেটওয়ার্কের মাধ্যমে প্রেরিত করার অনুমতি দেওয়ার জন্য দ্বিতীয় ধাপের প্রয়োজন।

json_post = json.dumps(graphql_query)
json_post_encoded = json_post.encode()

অবশেষে অনুরোধ অবজেক্টটি তৈরি করা হয় এবং প্রোগ্রামটি এখন সার্ভারে get_total_admins কল পাঠাতে প্রস্তুত।

request = urllib.request.Request(url=cato_api_url, data=json_post_encoded, headers=headers)

এখানে প্রোগ্রামটি urllib লাইব্রেরির urlopen ফাংশন কল করে গ্রাফিকএল সার্ভারে অনুরোধ পাঠায়।  এই ফাংশন কল করা HTTPResponse অবজেক্টের ফলাফল হবে।  

response = urllib.request.urlopen(request, context=unverified_ctx, timeout=30)

urlopen ফাংশন দ্বারা ফেরত দেওয়া অবজেক্টটিতে একটি বডি ক্ষেত্র রয়েছে যা সার্ভার দ্বারা ফেরত দেওয়া JSON ডকুমেন্টটি ধারণ করে।  এটি bytes অবজেক্টের ডিকোড পদ্ধতি কল করে একটি স্ট্রিং অবজেক্টে রূপান্তরিত হয়।  অবশেষে এই bytes অবজেক্টটি read পদ্ধতি কল করে একটি স্ট্রিং অবজেক্টে রূপান্তরিত হয়।

json_response_encoded = response.read()
json_response = json_response_encoded.decode()

এই ডিকোড করা স্ট্রিংটি একটি JSON ডকুমেন্ট রয়েছে যা দেখতে এরকম হবে:

{    
    "data" : {
         "admins" : {
              "total": 4
         }
    }
}

আপনি দেখবেন, ফেরত আসা ডেটার বিন্যাসটি সার্ভারে পাঠানো অনুরোধের বিন্যাসের মত দেখাচ্ছে।  এটা ইচ্ছাকৃত এবং API বাস্তবায়নের জন্য GraphQL স্পেসিফিকেশন ব্যবহারের আরেকটি সুবিধা।  এই পদ্ধতিটি ডেটাকে অনুরোধের একই আকারে রেখে অ্যাপ্লিকেশনটির কোডিং সহজ করে।

এই প্রোগ্রামের অংশের শেষ কোড লাইনটি ফেরত পাওয়া JSON স্ট্রিংকে পাইটনের নেস্টেড ডিকশনারিতে রূপান্তর করতে json লাইব্রেরি ফাংশন 'loads' ব্যবহার করে।  

get_total_admin_result = json.loads(json_response)

কোডের শেষ দুটি লাইন সার্ভার দ্বারা ফেরত আনা total ক্ষেত্র থেকে মানটি বের করে এবং এটি কনসোলে প্রিন্ট করে। 

total = get_total_admins_result['data']['get_total_admins']['total']
print('আপনার অ্যাকাউন্টের জন্য সংজ্ঞায়িত মোট প্রশাসক সংখ্যা হল: {}'.format(total)) 

আউটপুটটি এরকম দেখাবে:

আপনার অ্যাকাউন্টের জন্য সংজ্ঞায়িত মোট প্রশাসক সংখ্যা হল: 4