Python SDK

Dhibiti upangishaji wako kupitia Python

zinn-sdk ni mteja wa Python mwenye aina maalum kwa ajili ya API ya Zinn Digital®, iliyotengenezwa kutoka kwa ubainifu uleule wa OpenAPI ambao API hiyo imejengwa kwayo. Kila operesheni ina lahaja za ulandanishi na za asyncio, na kila ombi na jibu ni modeli iliyo na aina maalum.

Nyaraka zote za watengenezaji →

Sakinisha

Kifurushi hiki kinapatikana kwenye PyPI kama zinn-sdk na huingizwa kama zinn_sdk. Kinahitaji Python 3.11 au toleo jipya zaidi.

pip install zinn-sdk

Kuanza haraka

Orodhesha maeneo ya umma ya upangishaji bila ufunguo, kisha uorodheshe tovuti zako mwenyewe ukiwa na ufunguo.

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)

Uthibitishaji

Vituo vya mwisho vya orodha ya umma, kama vile maeneo na mipango, havihitaji kitambulisho. Kila kitu kingine kinatumia ufunguo wa API kwa kila shirika unaopitishwa kwa AuthenticatedClient, ambayo huituma kama tokeni ya mchukuzi. Ufunguo hubeba tu ruhusa unazoupa wakati unapouunda, na unaweza kuubatilisha wakati wowote. Uweke kwenye kigezo cha mazingira au hifadhi yako ya siri, kamwe usiuweke kwenye msimbo wa chanzo.

Unda ufunguo wa API kwenye dashibodi yako

Unachopata

Miundo iliyoainishwa aina

Maombi na majibu ni miundo ya attrs yenye vidokezo vya aina, kwa hivyo kihariri chako na kikaguzi chako cha aina huelewa kila sehemu.

Ulandanishaji na asyncio

Kila operesheni ina kazi za sync, sync_detailed, asyncio na asyncio_detailed, zilizopewa jina kulingana na operesheni hiyo kwa mtindo wa snake case na kupangwa kwa eneo la API chini ya zinn_sdk.api.

Imezalishwa kutoka kwenye vipimo

Toleo jipya huchapishwa kiotomatiki kila wakati ubainishaji wa OpenAPI unapobadilika. Shughuli chache ambazo jenereta bado haiwezi kuzieleza huorodheshwa na kukaguliwa katika kila toleo, na husalia kupatikana kupitia REST API.

Simu zisizo za wakati mmoja

Wito uleule kwa kutumia asyncio, unaorejesha hali ya HTTP pamoja na jibu lililochanganuliwa.

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

Viungo

Maswali

Je, una Python SDK?

Ndiyo. Sakinisha zinn-sdk kutoka PyPI kwa kutumia pip install zinn-sdk kisha uingize zinn_sdk. Ni kiteja chenye aina maalum za data kilichoundwa kutoka kwa ubainifu wetu wa OpenAPI, kikiwa na miito ya ulandanishi na asyncio.

Wapi kituo maalum kinapatikana katika Python SDK?

Shughuli zimepangwa kulingana na eneo la API chini ya zinn_sdk.api na kupewa majina kulingana na id ya shughuli husika katika snake case. Kwa mfano, kuorodhesha tovuti ni zinn_sdk.api.hosting.list_sites.

Ni matoleo yapi ya Python yanayotumika?

Python 3.11 na matoleo ya baadaye.

Chunguza kila kituo cha mwisho

Kila operesheni ambayo SDK inaweza kuiita imefafanuliwa katika marejeleo ya API, pamoja na vigezo, majibu na ruhusa zake.

Marejeleo ya API