Python SDK
Python மூலம் உங்கள் ஹோஸ்டிங்கை இயக்கவும்
zinn-sdk என்பது Zinn Digital® API-க்கான ஒரு தட்டச்சு செய்யப்பட்ட Python கிளையன்ட் ஆகும், இது API கட்டமைக்கப்பட்ட அதே OpenAPI விவரக்குறிப்பிலிருந்து உருவாக்கப்பட்டது. ஒவ்வொரு செயல்பாட்டிற்கும் ஒத்திசைவான மற்றும் 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)அங்கீகாரம்
பிராந்தியங்கள் மற்றும் திட்டங்கள் போன்ற பொதுப் பட்டியல் இறுதிப்புள்ளிகளுக்கு எந்தச் சான்றளிப்பும் தேவையில்லை. மற்றவை அனைத்தும் 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-ஐ இறக்குமதி செய்யவும். இது எங்கள் OpenAPI விவரக்குறிப்பிலிருந்து உருவாக்கப்பட்ட ஒரு தட்டச்சு செய்யப்பட்ட கிளையன்ட் ஆகும், இதில் ஒத்திசைவான மற்றும் asyncio அழைப்புகள் உள்ளன.
Python SDK-இல் கொடுக்கப்பட்ட இறுதிப் புள்ளி எங்கே உள்ளது?
செயல்பாடுகள் zinn_sdk.api இன் கீழ் API பகுதி வாரியாக தொகுக்கப்பட்டு, அவற்றின் செயல்பாட்டு ஐடிக்கு (operation id) ஏற்ப snake case இல் பெயரிடப்பட்டுள்ளன. உதாரணமாக, தளங்களை பட்டியலிடுவது zinn_sdk.api.hosting.list_sites ஆகும்.
எந்த Python பதிப்புகள் ஆதரிக்கப்படுகின்றன?
Python 3.11 மற்றும் அதற்குப் பிந்தைய பதிப்புகள்.
ஒவ்வொரு முனைப்புள்ளியையும் ஆராயுங்கள்
SDK அழைக்கக்கூடிய ஒவ்வொரு செயல்பாடும் அதன் அளவுருக்கள், பதில்கள் மற்றும் அனுமதிகளுடன் API குறிப்பில் விவரிக்கப்பட்டுள்ளது.