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 ಕೀಲಿಯನ್ನು ಬಳಸುತ್ತದೆ, ಅದು ಅದನ್ನು ಬೇರರ್ ಟೋಕನ್ ಆಗಿ ಕಳುಹಿಸುತ್ತದೆ. ಒಂದು ಕೀಲಿಯು ನೀವು ಅದನ್ನು ರಚಿಸುವಾಗ ನೀಡುವ ಅನುಮತಿಗಳನ್ನು ಮಾತ್ರ ಹೊಂದಿರುತ್ತದೆ ಮತ್ತು ನೀವು ಅದನ್ನು ಯಾವಾಗ ಬೇಕಾದರೂ ಹಿಂಪಡೆಯಬಹುದು. ಅದನ್ನು ಪರಿಸರ ವೇರಿಯೇಬಲ್ ಅಥವಾ ನಿಮ್ಮ ರಹಸ್ಯ ಸಂಗ್ರಹಣೆಯಲ್ಲಿ ಇರಿಸಿ, ಮೂಲ ಕೋಡ್‌ನಲ್ಲಿ ಎಂದಿಗೂ ಇರಿಸಬೇಡಿ.

ನಿಮ್ಮ ಡ್ಯಾಶ್‌ಬೋರ್ಡ್‌ನಲ್ಲಿ 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 ವಲಯದ ಪ್ರಕಾರ ವರ್ಗೀಕರಿಸಲಾಗಿದೆ ಮತ್ತು ಅವುಗಳ ಕಾರ್ಯಾಚರಣೆ ID ಗೆ ಅನುಗುಣವಾಗಿ snake case ನಲ್ಲಿ ಹೆಸರಿಸಲಾಗಿದೆ. ಉದಾಹರಣೆಗೆ, ಸೈಟ್‌ಗಳನ್ನು ಪಟ್ಟಿ ಮಾಡುವುದು zinn_sdk.api.hosting.list_sites ಆಗಿದೆ.

ಯಾವ Python ಆವೃತ್ತಿಗಳು ಬೆಂಬಲಿತವಾಗಿವೆ?

Python 3.11 ಮತ್ತು ನಂತರದ ಆವೃತ್ತಿಗಳು.

ಪ್ರತಿಯೊಂದು ಎಂಡ್‌ಪಾಯಿಂಟ್ ಅನ್ನು ಅನ್ವೇಷಿಸಿ

SDK ಕರೆಯಬಹುದಾದ ಪ್ರತಿಯೊಂದು ಕಾರ್ಯಾಚರಣೆಯನ್ನು ಅದರ ನಿಯತಾಂಕಗಳು, ಪ್ರತಿಕ್ರಿಯೆಗಳು ಮತ್ತು ಅನುಮತಿಗಳೊಂದಿಗೆ API ಉಲ್ಲೇಖದಲ್ಲಿ ವಿವರಿಸಲಾಗಿದೆ.

API ಉಲ್ಲೇಖ