Python SDK

Sarrafa hosting ɗinku daga Python

zinn-sdk wani abokin ciniki ne na Python da aka rubuta don Zinn Digital® API, wanda aka samar daga ƙayyadaddun OpenAPI iri ɗaya da aka gina API ɗin daga gare ta. Kowane aiki yana da bambance-bambancen synchronous da asyncio, kuma kowace buƙata da amsa abin ƙira ne da aka rubuta.

Duk takardun mai haɓakawa →

Sanya

Kunshin yana kan PyPI a matsayin zinn-sdk kuma ana shigo da shi a matsayin zinn_sdk. Yana buƙatar Python 3.11 ko na gaba.

pip install zinn-sdk

Fara cikin sauri

Jera yankunan karɓar baƙuncin yanar gizo na jama'a ba tare da mabuɗi ba, sannan ka jera shafukanka tare da guda ɗaya.

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)

Tabbatarwa

Teburan karshe na kundin tsarin jama'a, kamar yankuna da tsare-tsare, ba sa buƙatar wata shaida. Duk wani abu daban yana amfani da maɓallin API na kowace ƙungiya wanda aka miƙa wa AuthenticatedClient, wanda ke aika shi azaman alamar ɗauka. Maɓalli yana ɗaukar izinin da kuka ba shi kawai lokacin da kuka ƙirƙira shi, kuma kuna iya soke shi a kowane lokaci. Ajiye shi a cikin canjin muhalli ko ma'ajiyar asirin ku, kar a taɓa sanya shi a cikin lambar tushe.

Ƙirƙiri maɓallin API a cikin allon sarrafawarku

Abin da za ku samu

Samfuran da aka tantance nau'insu

Bukatu da martanoni samfuran attrs ne masu nuni na nau'i, don haka editan ku da mai duba nau'in ku suna fahimtar kowane fage.

Daidaitawa da asyncio

Kowane aiki yana da ayyukan sync, sync_detailed, asyncio da asyncio_detailed, waɗanda aka sanya wa suna bayan aikin a cikin snake case kuma aka tattara su ta fannin API a ƙarƙashin zinn_sdk.api.

An samar daga ƙayyadaddun bayanai

Ana buga sabon babi kai tsaye a duk lokacin da bayanin OpenAPI ya canza. Ƴan ayyukan da na'urar samarwa ba za ta iya bayyanawa ba a halin yanzu ana jera su kuma ana duba su a kowane fitarwa, kuma suna ci gaba da kasancewa a buɗe ta hanyar REST API.

Kiran da ba a haɗa lokaci ba

Kira guda tare da asyncio, yana dawo da matsayin HTTP da kuma amsar da aka bincika.

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

Hanyoyin haɗi

Tambayoyi

Kuna da Python SDK?

Ee. Shigar da zinn-sdk daga PyPI tare da pip install zinn-sdk kuma shigo da zinn_sdk. Abokin ciniki ne da aka buga wanda aka samar daga ƙayyadaddun OpenAPI ɗinmu, tare da kiran aiki tare da asyncio.

A ina wani endpoint yake a cikin Python SDK?

Ana rukunin ayyuka ta fannin API a karkashin zinn_sdk.api kuma ana sanya musu suna daidai da operation id dinsu a cikin snake case. Misali, lissafa shafuka shine zinn_sdk.api.hosting.list_sites.

Wanne nau'ikan Python ake goyan baya?

Python 3.11 da na gaba.

Bincika kowane endpoint

Kowane aiki da SDK zai iya kira an bayyana shi a cikin bayanan API, tare da ma'aunansa, martanoni da izininsa.

Bayanin API