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 కీని ఉపయోగిస్తాయి, ఇది దానిని బేరర్ టోకెన్‌గా పంపుతుంది. మీరు కీని సృష్టించినప్పుడు దానికి ఇచ్చే అనుమతులను మాత్రమే అది కలిగి ఉంటుంది మరియు మీరు దానిని ఎప్పుడైనా రద్దు చేయవచ్చు. దానిని ఎన్విరాన్మెంట్ వేరియబుల్‌లో లేదా మీ సీక్రెట్ స్టోర్‌లో ఉంచండి, సోర్స్ కోడ్‌లో ఎప్పుడూ ఉంచవద్దు.
మీరు ఏమి పొందుతారు
టైప్ చేసిన నమూనాలు
అభ్యర్థనలు మరియు ప్రతిస్పందనలు రకం సూచనలతో కూడిన 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ని దిగుమతి చేసుకోండి. ఇది సింక్రోనస్ మరియు asyncio కాల్లతో మా OpenAPI వివరణ నుండి రూపొందించబడిన టైప్ చేయబడిన క్లయింట్.
Python SDKలో ఇచ్చిన ఎండ్పాయింట్ ఎక్కడ ఉంది?
ఆపరేషన్లు zinn_sdk.api కింద API ప్రాంతం ఆధారంగా సమూహం చేయబడ్డాయి మరియు snake case లో వాటి ఆపరేషన్ ఐడిని బట్టి పేరు పెట్టబడ్డాయి. ఉదాహరణకు, సైట్లను జాబితా చేయడం zinn_sdk.api.hosting.list_sites.
ఏ Python వెర్షన్‌లకు మద్దతు ఉంది?
Python 3.11 మరియు తర్వాతి వెర్షన్లు.
ప్రతి ఎండ్‌పాయింట్‌ను అన్వేషించండి
SDK కాల్ చేయగల ప్రతి ఆపరేషన్ దాని పారామితులు, ప్రతిస్పందనలు మరియు అనుమతులతో సహా API రిఫరెన్స్‌లో వివరించబడింది.