Python SDK

Python થી તમારા હોસ્ટિંગનું સંચાલન કરો

zinn-sdk એ Zinn Digital® API માટે ટાઇપ કરેલ Python ક્લાયન્ટ છે, જે સમાન OpenAPI સ્પષ્ટીકરણમાંથી જનરેટ કરવામાં આવ્યું છે જેમાંથી API બનાવવામાં આવ્યું છે. દરેક ઑપરેશનમાં સિંક્રનસ અને 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)

પ્રમાણીકરણ

જાહેર કૅટેલૉગ એન્ડપૉઇન્ટ્સ, જેમ કે પ્રદેશો અને પ્લાન્સ, માટે કોઈ ઓળખપત્રની જરૂર નથી. બાકીનું બધું સંસ્થા-દીઠ API કીનો ઉપયોગ કરે છે જે 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 વિસ્તાર અનુસાર જૂથબદ્ધ કરવામાં આવ્યા છે અને તેમના ઑપરેશન આઈડી (operation id) પરથી snake case માં નામ આપવામાં આવ્યા છે. ઉદાહરણ તરીકે, સાઇટ્સની સૂચિ બનાવવી એ zinn_sdk.api.hosting.list_sites છે.

કઈ Python આવૃત્તિઓ સમર્થિત છે?

Python 3.11 અને પછીનું.

દરેક એન્ડપોઇન્ટનું અન્વેષણ કરો

SDK કૉલ કરી શકે તેવી દરેક કામગીરીનું વર્ણન API સંદર્ભમાં તેના પરિમાણો, જવાબો અને પરવાનગીઓ સાથે કરવામાં આવ્યું છે.

API સંદર્ભ