Python SDK

Ka maamul martigelintaada Python

zinn-sdk waa macmiil Python oo noocaysan oo loogu talagalay Zinn Digital® API, kaas oo laga soo saaray isla qeexitaanka OpenAPI ee API-ga laga dhisay. Hawlgal kasta wuxuu leeyahay noocyo isku mar ah iyo kuwa asyncio ah, codsi iyo jawaab kastaana waa moodal noocaysan.

Dhammaan dukumentiyada horumariyaha →

Geli

Xirmadu waxay ku jirtaa PyPI ahaan zinn-sdk waxaana loo soo geliyaa sidii zinn_sdk. Waxay u baahan tahay Python 3.11 ama mid ka dambeeya.

pip install zinn-sdk

Bilaabid degdeg ah

Liis garee gobollada martigelinta dadweynaha adiga oo aan fure wadan, ka dibna liis garee bogaggaaga adiga oo fure wata.

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)

Xaqiijinta

Barta dhammaadka buug-liiska guud, sida gobollada iyo qorshayaasha, uma baahna wax aqoonsi ah. Wax kasta oo kale waxay adeegsadaan furaha API ee urur-kasta oo loo gudbiyo AuthenticatedClient, kaas oo u dira calaamadda xambaaraha (bearer token). Furuhu waxa uu sitaa oo keliya rukhsadaha aad siiso marka aad abuurto, waxaanad burin kartaa wakhti kasta. Ku hay doorsoomaha deegaanka ama kaydkaaga sirta ah, waligaa ha gelin koodhka asalka ah.

Ka sameyso furaha API dashboard-kaaga

Waxaad helayso

Moodallada nooca leh

Codsiyada iyo jawaabaha waa moodallo attrs ah oo leh tilmaamo nooc ah, sidaas darteed tifaftirahaaga iyo hubiyahaaga nooca ayaa fahmaya goob kasta.

Isku-dubaridka iyo asyncio

Hawlgal kasta wuxuu leeyahay hawlo sync, sync_detailed, asyncio iyo asyncio_detailed, kuwaas oo loogu magac daray hawlgalka qaabka snake case loona kala qaybiyay aagga API ee hoos yimaada zinn_sdk.api.

Laga soo saaray faahfaahinta

Nooc cusub ayaa si toos ah loo daabacaa mar kasta oo qeexitaanka OpenAPI uu isbeddelo. Hawlaha kooban ee uusan soo-saaruhu weli muujin karin ayaa la qoraa oo la hubiyaa marka la sii daayo kasta, waxayna ku sii jiraan kuwo laga heli karo REST API.

Wicitaanada aan isku mar ahayn

Isla wicitaankii oo leh asyncio, oo soo celinaya heerka HTTP iyo jawaabta la fasiray labadaba.

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())

Xiriirinta

Su'aalo

Ma leedahay Python SDK?

Haa. Ka soo geli zinn-sdk xagga PyPI adigoo isticmaalaya pip install zinn-sdk oo soo daji zinn_sdk. Waa macmiil noocaysan oo laga sameeyay qeexitaankayaga OpenAPI, oo leh wicitaanno isku mar ah iyo asyncio.

Xaggee buu ku yaallaa barta dhammaadka la bixiyay ee Python SDK?

Hawlaha waxaa loo qaybiyay aagga API ee hoos yimaada zinn_sdk.api waxaana loogu magac daray id-ga hawshooda qaabka snake case. Tusaale ahaan, liis gareynta bogagga waa zinn_sdk.api.hosting.list_sites.

Noocyada Python eetee la taageeraa?

Python 3.11 iyo wixii ka dambeeya.

Sahami bar-dhamaad kasta

Hawlgal kasta oo SDK-gu wici karo waxaa lagu sharxay tixraaca API-ga, iyadoo ay la socdaan cabbirradiisa, jawaabaha iyo oggolaanshaha.

Tixraaca API