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 ප්‍රදේශය අනුව කාණ්ඩ කර ඇති අතර snake case ක්‍රමයට ඒවායේ operation id අනුව නම් කර ඇත. අඩවි ලැයිස්තුගත කිරීම zinn_sdk.api.hosting.list_sites වේ; වසම් (domains) සහ DNS පවතින්නේ zinn_sdk.api.domains යටතේ ය; බිල්පත්කරණය zinn_sdk.api.billing යටතේ පවතී. API විමර්ශනය මඟින් එක් එක් මෙහෙයුමේ id පෙන්වයි.

සමමුහුර්ත, අසමමුහුර්ත සහ සම්පූර්ණ ප්‍රතිචාරය

සෑම මෙහෙයුම් මොඩියුලයකම ශ්‍රිත හතරක් ඇත:

• sync(...) මඟින් විග්‍රහ කළ ආකෘතිය ලබා දෙන අතර, බලාපොරොත්තු නොවූ තත්ත්වයකදී None ලබා දෙයි.
• sync_detailed(...) මඟින් status_code, headers සහ parsed සහිත Response එකක් ලබා දෙයි.
• asyncio(...) සහ asyncio_detailed(...) ද එලෙසම වේ, awaitable වේ.

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