Python SDK (zinn-sdk) ಬಳಸುವುದು

zinn-sdk ಎಂಬುದು Zinn Digital® API ಗಾಗಿ ನಮ್ಮ ಅಧಿಕೃತ Python ಕ್ಲೈಂಟ್ ಆಗಿದೆ, ಇದನ್ನು PyPI ನಲ್ಲಿ ಪ್ರಕಟಿಸಲಾಗಿದೆ ಮತ್ತು zinn_sdk ಆಗಿ ಆಮದು ಮಾಡಿಕೊಳ್ಳಲಾಗುತ್ತದೆ. API ಅನ್ನು ನಿರ್ಮಿಸಲಾದ ಅದೇ OpenAPI ನಿರ್ದಿಷ್ಟತೆಯಿಂದ ಇದನ್ನು ರಚಿಸಲಾಗಿದೆ, ಪ್ರತಿಯೊಂದು ಕಾರ್ಯಾಚರಣೆಯು ಸಿಂಕ್ರೊನಸ್ ಮತ್ತು asyncio ರೂಪಾಂತರಗಳನ್ನು ಹೊಂದಿದೆ, ಮತ್ತು ನಿರ್ದಿಷ್ಟತೆಯು ಬದಲಾದಾಗಲೆಲ್ಲಾ ಹೊಸ ಆವೃತ್ತಿಯನ್ನು ಸ್ವಯಂಚಾಲಿತವಾಗಿ ಪ್ರಕಟಿಸಲಾಗುತ್ತದೆ. ಈ ಮಾರ್ಗದರ್ಶಿಯು ಅದನ್ನು ಸ್ಥಾಪಿಸುತ್ತದೆ, ದೃಢೀಕರಿಸುತ್ತದೆ ಮತ್ತು ನಿಮ್ಮ ಮೊದಲ ಕರೆಗಳನ್ನು ಮಾಡುತ್ತದೆ.

ಸ್ಥಾಪಿಸಿ

pip install zinn-sdk

ಇದಕ್ಕೆ Python 3.11 ಅಥವಾ ನಂತರದ ಆವೃತ್ತಿಯ ಅಗತ್ಯವಿದೆ ಮತ್ತು ಇದು MIT ಪರವಾನಗಿ ಪಡೆದಿದೆ.

API ಕೀಲಿಯನ್ನು ರಚಿಸಿ

ನಿಮ್ಮ ಡ್ಯಾಶ್‌ಬೋರ್ಡ್‌ನ API ಕೀಲಿಗಳು ಪುಟವನ್ನು ತೆರೆಯಿರಿ (app.zinndigital.com/api-keys) ಮತ್ತು ಕೀಲಿಯನ್ನು ರಚಿಸಿ ಅನ್ನು ಒತ್ತಿರಿ. ಕೀಲಿಗೆ ಹೆಸರನ್ನು ನೀಡಿ ಮತ್ತು ನಿಮ್ಮ ಕೋಡ್‌ಗೆ ಅಗತ್ಯವಿರುವ ಅನುಮತಿಗಳನ್ನು ಮಾತ್ರ ನೀಡಿ — ಉದಾಹರಣೆಗೆ ಸೈಟ್‌ಗಳನ್ನು ಪಟ್ಟಿ ಮಾಡಲು sites.view. ಕೀಲಿಯನ್ನು ಒಮ್ಮೆ ಮಾತ್ರ ತೋರಿಸಲಾಗುತ್ತದೆ; ಅದನ್ನು ಪರಿಸರ ವೇರಿಯೇಬಲ್ ಅಥವಾ ನಿಮ್ಮ ರಹಸ್ಯ ಸಂಗ್ರಹದಲ್ಲಿ ಸಂಗ್ರಹಿಸಿ, ಎಂದಿಗೂ ಮೂಲ ಕೋಡ್‌ನಲ್ಲಿ ಇಡಬೇಡಿ. ನೀವು ಅದೇ ಪುಟದಲ್ಲಿ ಯಾವುದೇ ಸಮಯದಲ್ಲಿ ಕೀಲಿಯನ್ನು ರದ್ದುಗೊಳಿಸಬಹುದು.

ಹೋಸ್ಟಿಂಗ್ ಪ್ರದೇಶಗಳು ಮತ್ತು ಯೋಜನೆಗಳಂತಹ ಸಾರ್ವಜನಿಕ ಕ್ಯಾಟಲಾಗ್ ಎಂಡ್‌ಪಾಯಿಂಟ್‌ಗಳಿಗೆ ಯಾವುದೇ ಕೀಲಿಯ ಅಗತ್ಯವಿಲ್ಲ.

ನಿಮ್ಮ ಮೊದಲ ಕರೆಗಳು

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)

ಕಾರ್ಯಾಚರಣೆಯನ್ನು ಹುಡುಕುವುದು

ಕಾರ್ಯಾಚರಣೆಗಳನ್ನು zinn_sdk.api ಅಡಿಯಲ್ಲಿ API ಪ್ರದೇಶದ ಪ್ರಕಾರ ಗುಂಪು ಮಾಡಲಾಗಿದೆ ಮತ್ತು ಅವುಗಳ ಕಾರ್ಯಾಚರಣೆ ID ಯ ಆಧಾರದ ಮೇಲೆ snake case ನಲ್ಲಿ ಹೆಸರಿಸಲಾಗಿದೆ. ಸೈಟ್‌ಗಳನ್ನು ಪಟ್ಟಿ ಮಾಡುವುದು zinn_sdk.api.hosting.list_sites ಆಗಿದೆ; ಡೊಮೇನ್‌ಗಳು ಮತ್ತು DNS zinn_sdk.api.domains ಅಡಿಯಲ್ಲಿವೆ; ಬಿಲ್ಲಿಂಗ್ zinn_sdk.api.billing ಅಡಿಯಲ್ಲಿವೆ. API ಉಲ್ಲೇಖವು ಪ್ರತಿಯೊಂದು ಕಾರ್ಯಾಚರಣೆಯ ID ಯನ್ನು ತೋರಿಸುತ್ತದೆ.

ಸಿಂಕ್, ಅಸಿಂಕ್ ಮತ್ತು ಪೂರ್ಣ ಪ್ರತಿಕ್ರಿಯೆ

ಪ್ರತಿಯೊಂದು ಕಾರ್ಯಾಚರಣೆಯ ಮಾಡ್ಯೂಲ್ ನಾಲ್ಕು ಕಾರ್ಯಗಳನ್ನು ಹೊಂದಿದೆ:

• sync(...) ಪಾರ್ಸ್ ಮಾಡಲಾದ ಮಾದರಿಯನ್ನು ಹಿಂತಿರುಗಿಸುತ್ತದೆ, ಅಥವಾ ಅನಿರೀಕ್ಷಿತ ಸ್ಥಿತಿಯ ಮೇಲೆ None ಹಿಂತಿರುಗಿಸುತ್ತದೆ.
• sync_detailed(...) status_code, headers ಮತ್ತು parsed ನೊಂದಿಗೆ Response ಅನ್ನು ಹಿಂತಿರುಗಿಸುತ್ತದೆ.
• asyncio(...) ಮತ್ತು asyncio_detailed(...) ಒಂದೇ ಆಗಿರುತ್ತವೆ, ಇವುಗಳನ್ನು await ಮಾಡಬಹುದಾಗಿದೆ.

import asyncio

from zinn_sdk.api.hosting import list_sites

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

ನೀವು 403 (ಕೀಲಿಯು ಅನುಮತಿಯನ್ನು ಹೊಂದಿಲ್ಲ) ಮತ್ತು 404 ನಡುವಿನ ವ್ಯತ್ಯಾಸವನ್ನು ಗುರುತಿಸಬೇಕಾದಾಗ _detailed ರೂಪಾಂತರಗಳನ್ನು ಬಳಸಿ.

ಮುಂದಿನ ಹಂತಗಳು

• ನಮ್ಮ ವೆಬ್‌ಸೈಟ್‌ನಲ್ಲಿರುವ ಮಾರ್ಗದರ್ಶಿ: zinndigital.com/developers/sdk-python
• ಪ್ರತಿಯೊಂದು ಎಂಡ್‌ಪಾಯಿಂಟ್, ಅದರ ನಿಯತಾಂಕಗಳು ಮತ್ತು ಅದರ ಅನುಮತಿ: zinndigital.com/developers/api
• PyPI ನಲ್ಲಿನ ಪ್ಯಾಕೇಜ್: pypi.org/project/zinn-sdk