Python SDK

Python द्वारे तुमचे होस्टिंग व्यवस्थापित करा

zinn-sdk हे Zinn Digital® API साठी एक टाइप केलेले Python क्लायंट आहे, जे API ज्या OpenAPI स्पेसिफिकेशनमधून तयार केले आहे त्याचमधून व्युत्पन्न केले गेले आहे. प्रत्येक ऑपरेशनमध्ये सिंक्रोनस आणि 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)

प्रमाणीकरण

प्रदेश आणि योजना यांसारख्या सार्वजनिक कॅटलॉग एंडपॉइंट्सना कोणत्याही क्रेडेन्शियलची आवश्यकता नसते. इतर सर्व काही AuthenticatedClient कडे पाठवलेली संस्था-निहाय API की वापरते, जी ती बेअरर टोकन म्हणून पाठवते. की मध्ये केवळ आपण ती तयार करताना दिलेली परवानग्या असतात आणि आपण ती कधीही रद्द करू शकता. ती पर्यावरण व्हेरिएबलमध्ये किंवा आपल्या गुप्त भांडारात ठेवा, स्त्रोत कोडमध्ये कधीही ठेवू नका.

तुमच्या डॅशबोर्डमध्ये 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 संदर्भ