Python SDK

Python کے ذریعے اپنی ہوسٹنگ کا نظم کریں

⁦zinn-sdk Zinn Digital® API⁩ کے لیے ایک ٹائپ شدہ Python کلائنٹ ہے، جو اسی OpenAPI کی وضاحت سے تیار کیا گیا ہے جس سے API بنایا گیا ہے۔ ہر آپریشن میں مطابقت پذیر اور asyncio متغیرات ہوتے ہیں، اور ہر درخواست اور جواب ایک ٹائپ شدہ ماڈل ہے۔

تمام ڈویلپر دستاویزات →

انسٹال کریں

یہ پیکیج PyPI پر zinn-sdk کے طور پر دستیاب ہے اور اسے zinn_sdk کے طور پر درآمد کیا جاتا ہے۔ اس کے لیے Python 3.11 یا بعد کا ورژن درکار ہے۔

pip install zinn-sdk

فوری آغاز

کلید کے بغیر عوامی ہوسٹنگ کے خطوں کی فہرست بنائیں، پھر کلید کے ساتھ اپنی سائٹس کی فہرست بنائیں۔

import os

from zinn_sdk import AuthenticatedClient, Client
from zinn_sdk.api.catalog import list_public_hosting_regions
from zinn_sdk.api.hosting import list_sites

# Public catalogue endpoints need no key.
public = Client(base_url="https://api.zinndigital.com")
regions = list_public_hosting_regions.sync(client=public)
print([region.slug for region in regions.data])

# Everything else uses a per-organisation API key.
api = AuthenticatedClient(base_url="https://api.zinndigital.com", token=os.environ["ZINN_API_KEY"])
page = list_sites.sync(client=api, limit=5)
for site in page.data:
    print(site.name, site.status)

تصدیق

عوامی کیٹلاگ اینڈ پوائنٹس، جیسے کہ خطے اور منصوبے، کو کسی اسناد کی ضرورت نہیں ہوتی ہے۔ باقی تمام چیزیں فی تنظیم ایک API کلید استعمال کرتی ہیں جو AuthenticatedClient کو بھیجی جاتی ہے، جو اسے بطور بیئرر ٹوکن بھیجتی ہے۔ ایک کلید صرف وہی اجازتیں رکھتی ہے جو آپ اسے بناتے وقت دیتے ہیں، اور آپ اسے کسی بھی وقت منسوخ کر سکتے ہیں۔ اسے کسی انوائرنمنٹ ویری ایبل یا اپنے راز کے اسٹور میں رکھیں، کبھی بھی سورس کوڈ میں نہ رکھیں۔

اپنے ڈیش بورڈ میں API کلید بنائیں

آپ کو کیا ملتا ہے

ٹائپ شدہ ماڈلز

درخواستیں اور جوابات قسم کے اشاروں والے attrs ماڈلز ہیں، اس لیے آپ کا ایڈیٹر اور آپ کا ٹائپ چیکر ہر فیلڈ کو سمجھتے ہیں۔

مطابقت پذیری اور asyncio

ہر آپریشن کے پاس sync، sync_detailed، asyncio، اور asyncio_detailed کے فنکشنز موجود ہیں، جن کے نام snake case میں آپریشن کی مناسبت سے رکھے گئے ہیں اور انہیں zinn_sdk.api کے تحت API کے شعبے کے لحاظ سے گروپ کیا گیا ہے۔

تفصیلات سے تیار کردہ

جب بھی OpenAPI کی تفصیلات تبدیل ہوتی ہیں تو ایک نیا ورژن خودکار طور پر شائع ہو جاتا ہے۔ وہ چند آپریشنز جن کا جنریٹر ابھی اظہار نہیں کر سکتا، ہر ریلیز پر درج اور چیک کیے جاتے ہیں، اور REST API کے ذریعے دستیاب رہتے ہیں۔

غیر مطابقت پذیر کالز

asyncio کے ساتھ وہی کال، جو تجزیہ کردہ جواب کے ساتھ ساتھ HTTP کی حیثیت بھی واپس کرتی ہے۔

import asyncio

from zinn_sdk.api.hosting import list_sites

# Every operation has sync, sync_detailed, asyncio and asyncio_detailed variants.
async def main() -> None:
    response = await list_sites.asyncio_detailed(client=api, limit=5)
    print(response.status_code, len(response.parsed.data))

asyncio.run(main())

روابط

سوالات

کیا آپ کے پاس Python SDK ہے؟

جی ہاں۔ pip install zinn-sdk کے ذریعے PyPI سے zinn-sdk انسٹال کریں اور zinn_sdk امپورٹ کریں۔ یہ ہماری OpenAPI کی وضاحت سے تیار کردہ ایک ٹائپ شدہ کلائنٹ ہے، جس میں سنکرونس اور asyncio کالز شامل ہیں۔

Python SDK میں ایک مخصوص اینڈ پوائنٹ کہاں ہے؟

آپریشنز کو zinn_sdk.api کے تحت API کے شعبے کے لحاظ سے گروپ کیا گیا ہے اور ان کے آپریشن آئی ڈی کے مطابق snake case میں نام دیا گیا ہے۔ مثال کے طور پر، سائٹس کی فہرست بنانا zinn_sdk.api.hosting.list_sites ہے۔

Python کے کون سے ورژن تعاون یافتہ ہیں؟

Python 3.11 اور بعد کے ورژن۔

ہر اینڈ پوائنٹ دریافت کریں

ہر وہ آپریشن جسے SDK کال کر سکتا ہے اس کی وضاحت API کے حوالے میں اس کے پیرامیٹرز، جوابات اور اجازتوں کے ساتھ کی گئی ہے۔

API حوالہ