Python SDK

Drejtojeni hostimin tuaj me Python

zinn-sdk është një klient i tipizuar Python për API-n e Zinn Digital®, i gjeneruar nga i njëjti specifikim OpenAPI mbi të cilin është ndërtuar vetë API-ja. Çdo veprim ka variante sinkrone dhe asyncio, dhe çdo kërkesë e përgjigje është një model i tipizuar.

I gjithë dokumentacioni i zhvilluesit →

Instalo

Paketa gjendet në PyPI si zinn-sdk dhe importohet si zinn_sdk. Ajo kërkon Python 3.11 ose më të ri.

pip install zinn-sdk

Fillim i shpejtë

Rreshtoni rajonet publike të pritjes pa një çelës, pastaj rreshtoni faqet tuaja me një çelës.

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)

Autentifikimi

Pikat përfundimtare të katalogut publik, të tilla si rajonet dhe planet, nuk kërkojnë kredenciale. Çdo gjë tjetër përdor një çelës API për çdo organizatë që i kalohet AuthenticatedClient, i cili e dërgon atë si një token mbajtës. Një çelës mbart vetëm lejet që ju i jepni kur e krijoni atë dhe ju mund ta revokoni atë në çdo kohë. Mbajeni atë në një variabël mjedisi ose në ruajtësin tuaj të sekreteve, asnjëherë në kodin burimor.

Krijoni një çelës API në panelin tuaj

Çfarë përfitoni

Modele të tipizuara

Kërkesat dhe përgjigjet janë modele attrs me këshilla lloji, kështu që redaktori dhe kontrolluesi juaj i llojeve kuptojnë çdo fushë.

Sinkronizimi dhe asyncio

Çdo veprim ka funksionet sync, sync_detailed, asyncio dhe asyncio_detailed, të emërtuara sipas veprimit në formatin snake case dhe të grupuara sipas zonës së API-së nën zinn_sdk.api.

Gjeneruar nga specifikimi

Një version i ri publikohet automatikisht sa herë që ndryshon specifikimi i OpenAPI. Të paktat veprime që gjeneruesi nuk mund t'i shprehë ende listohen dhe kontrollohen në çdo version, dhe mbeten të disponueshme përmes REST API.

Thirrje asinkrone

E njëjta thirrje me asyncio, duke kthyer statusin HTTP si dhe përgjigjen e analizuar.

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

Lidhjet

Pyetje

A keni një Python SDK?

Po. Instaloni zinn-sdk nga PyPI me pip install zinn-sdk dhe importoni zinn_sdk. Është një klient i tipizuar i gjeneruar nga specifikimi ynë OpenAPI, me thirrje sinkrone dhe asyncio.

Ku ndodhet një pikë fundore e caktuar në Python SDK?

Veprimet janë të grupuara sipas zonës së API-së nën zinn_sdk.api dhe janë emërtuar sipas id-së së tyre të veprimit në snake case. Për shembull, listimi i faqeve është zinn_sdk.api.hosting.list_sites.

Cilat versione të Python mbështeten?

Python 3.11 dhe versionet më të reja.

Eksploroni çdo pikë përfundimtare

Çdo veprim që SDK-ja mund të thërrasë përshkruhet në referencën e API-së, së bashku me parametrat, përgjigjet dhe lejet e tij.

Referenca e API-t