سیکشن | تفصیل |
---|---|
تعارف | API تعامل کا جائزہ |
API دستاویزات کو سمجھنا | API دستاویزات کی اہمیت اور کلیدی عناصر |
اجازت دینے کے طریقے | API کی اجازت کی مختلف اقسام |
درخواستیں تشکیل دینا | API کی درخواستوں کی ساخت اور اجزاء |
درخواستیں بھیجنا | API کی درخواستیں بھیجنے کے لیے ٹولز اور زبانیں۔ |
جوابات کو سنبھالنا | API جوابات کو پارس کرنا اور استعمال کرنا |
API کی درخواستوں کی مثالیں۔ | مقبول خدمات کے لیے API کی درخواستوں کی عملی مثالیں۔ |
نتیجہ | اہم نکات کا خلاصہ |
تعارف
APIs (ایپلی کیشن پروگرامنگ انٹرفیس) کے ذریعے ویب سروسز کے ساتھ تعامل ایپلی کیشنز کو ڈیٹا کو مواصلت اور اشتراک کرنے کی اجازت دیتا ہے۔ APIs درخواستوں اور جوابات کے لیے قواعد اور فارمیٹس کی وضاحت کرتے ہیں، جس سے مختلف ایپلیکیشنز اور خدمات کے انضمام کو سیدھا بنایا جاتا ہے۔ اس مضمون میں، ہم تلاش کریں گے کہ APIs کے ذریعے ویب سروسز کے ساتھ کیسے تعامل کیا جائے، بشمول ڈیٹا حاصل کرنے کے لیے مقبول سروسز کی درخواستوں کی مثالیں۔
API دستاویزات کو سمجھنا
API دستاویزات بہت اہم ہیں کیونکہ یہ API کے ساتھ تعامل کے لیے تمام ضروری معلومات فراہم کرتا ہے۔ اس میں شامل ہیں:
- بنیادی URL: API کے اختتامی پوائنٹس کا بنیادی پتہ۔
- HTTP طریقے: GET، POST، PUT، DELETE جیسی کارروائیاں۔
- پیرامیٹرز: پیرامیٹرز سے استفسار کریں اور جسمانی ضروریات کی درخواست کریں۔
- رسپانس فارمیٹس: عام طور پر JSON یا XML۔
- اجازت: API تک رسائی کے طریقے، جیسے API کیز یا OAuth ٹوکنز۔
کامیاب API انضمام کے لیے ان عناصر کو سمجھنا ضروری ہے۔
اجازت دینے کے طریقے
زیادہ تر APIs کو اپنے ڈیٹا تک رسائی کے لیے اجازت کی کسی نہ کسی شکل کی ضرورت ہوتی ہے۔ عام طریقوں میں شامل ہیں:
- API کیز: درخواستوں میں شامل سادہ ٹوکن۔
- OAuth ٹوکنز: اجازت کے عمل کے ذریعے حاصل کردہ محفوظ ٹوکنز۔
- بیئرر ٹوکنز: اجازت کے ہیڈر میں استعمال ہونے والے ٹوکن۔
API کلید کے ساتھ API کی درخواست کی ایک مثال یہ ہے:
GET /data HTTP/1.1
Host: api.example.com
Authorization: Bearer your_api_key
درخواستیں تشکیل دینا
API کی درخواستوں میں عام طور پر شامل ہیں:
- HTTP طریقہ: کارروائی کی وضاحت کرتا ہے (مثال کے طور پر، ڈیٹا کی بازیافت کے لیے GET)۔
- اختتامی نقطہ URL: درخواست کے لیے مخصوص URL۔
- ہیڈرز: اجازت اور مواد کی قسم کی معلومات شامل کریں۔
- پیرامیٹرز: GET درخواستوں یا POST درخواستوں کے لیے باڈی ڈیٹا کے لیے استفسار کے پیرامیٹرز۔
مثال کے طور پر موسم کے API کو حاصل کرنے کی درخواست:
GET /weather?q=London&appid=your_api_key HTTP/1.1
Host: api.openweathermap.org
درخواستیں بھیجنا
آپ مختلف ٹولز اور زبانوں کا استعمال کرتے ہوئے API کی درخواستیں بھیج سکتے ہیں:
- curl: کمانڈ لائن ٹول۔
- ڈاکیا: APIs کی جانچ کے لیے GUI ٹول۔
- ازگر: درخواستوں کی لائبریری کا استعمال۔
- جاوا اسکرپٹ: fetch API یا axios لائبریری کا استعمال کرنا۔
ازگر کا استعمال کرنے کی مثال
import requests
api_key = "your_api_key"
city = "London"
url = f"http://api.openweathermap.org/data/2.5/weather?q={city}&appid={api_key}"
response = requests.get(url)
data = response.json()
if response.status_code == 200:
print(f"Current weather in {city}: {data['weather'][0]['description']}")
else:
print("Failed to retrieve data")
جوابات کو سنبھالنا
API کے جوابات میں شامل ہیں:
- اسٹیٹس کوڈز: کامیابی کی نشاندہی کریں (200 ٹھیک ہے) یا غلطیاں (404 نہیں ملی)۔
- باڈی ڈیٹا: اصل ڈیٹا واپس آیا، عام طور پر JSON فارمیٹ میں۔
ریسپانس ہینڈلنگ کی مثال
if response.status_code == 200:
print("Success:", data)
else:
print("Error:", response.status_code)
API کی درخواستوں کی مثالیں۔
مثال 1: OpenWeatherMap API
OpenWeatherMap موسم کا ڈیٹا فراہم کرتا ہے۔ یہاں ایک GET درخواست کی مثال ہے:
GET /data/2.5/weather?q=London&appid=your_api_key HTTP/1.1
Host: api.openweathermap.org
مثال 2: GitHub API
GitHub کا API آپ کو ذخیرہ کی معلومات تک رسائی کی اجازت دیتا ہے۔
GET /repos/octocat/Hello-World HTTP/1.1
Host: api.github.com
مثال 3: Twitter API
کسی صارف سے حالیہ ٹویٹس حاصل کرنے کے لیے، آپ کو OAuth ٹوکنز کی ضرورت ہے۔
Python میں Tweepy استعمال کرنے کی مثال
import tweepy
consumer_key = 'your_consumer_key'
consumer_secret = 'your_consumer_secret'
access_token = 'your_access_token'
access_token_secret = 'your_access_token_secret'
auth = tweepy.OAuth1UserHandler(consumer_key, consumer_secret, access_token, access_token_secret)
api = tweepy.API(auth)
username = "twitter_username"
tweets = api.user_timeline(screen_name=username, count=5)
for tweet in tweets:
print(f"{tweet.user.name} said: {tweet.text}")
نتیجہ
APIs کے ذریعے ویب سروسز کے ساتھ تعامل کرنا جدید ڈویلپرز کے لیے ایک بنیادی مہارت ہے۔ API دستاویزات، اجازت کے طریقوں، اور درخواستوں اور جوابات کی ساخت کو سمجھ کر، آپ اپنی ایپلی کیشنز میں مختلف ویب سروسز کو مؤثر طریقے سے ضم کر سکتے ہیں۔ فراہم کردہ مثالیں واضح کرتی ہیں کہ مقبول APIs سے درخواستیں کیسے کی جائیں، ان اصولوں کے عملی اطلاق کو ظاہر کرتے ہوئے۔
تبصرے (0)
یہاں ابھی تک کوئی تبصرہ نہیں ہے، آپ پہلے ہو سکتے ہیں!