Python SDK

ຈັດການໂຮສຕິ້ງຂອງທ່ານຜ່ານ Python

zinn-sdk ແມ່ນ Python ຄລາຍແອນທີ່ກຳນົດປະເພດສຳລັບ Zinn Digital® API, ເຊິ່ງຖືກສ້າງຂຶ້ນຈາກຂໍ້ກຳນົດ OpenAPI ດຽວກັນກັບທີ່ API ຖືກສ້າງຂຶ້ນ. ທຸກໆການດຳເນີນການມີຮູບແບບ synchronous ແລະ 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, ເຊິ່ງສົ່ງມັນເປັນ bearer token. ລະຫັດຈະມີພຽງການອະນຸຍາດທີ່ທ່ານມອບໃຫ້ເມື່ອທ່ານສ້າງມັນເທົ່ານັ້ນ, ແລະ ທ່ານສາມາດຖອນຄືນໄດ້ທຸກເວລາ. ກະລຸນາເກັບຮັກສາມັນໄວ້ໃນຕົວປ່ຽນສະພາບແວດລ້ອມ ຫຼື ບ່ອນເກັບຂໍ້ມູນລັບຂອງທ່ານ, ຢ່າເກັບໄວ້ໃນຊອດໂຄ້ດຢ່າງເດັດຂາດ.

ສ້າງລະຫັດ API ໃນໜ້າປັດຂອງທ່ານ

ສິ່ງທີ່ທ່ານຈະໄດ້ຮັບ

ໂມເດວທີ່ມີການກຳນົດປະເພດ

ຄຳຮ້ອງຂໍ ແລະ ການຕອບກັບແມ່ນໂມເດວ attrs ທີ່ມີຄຳແນະນຳປະເພດ, ດັ່ງນັ້ນຕົວແກ້ໄຂ ແລະ ຕົວກວດສອບປະເພດຂອງທ່ານຈຶ່ງເຂົ້າໃຈທຸກຊ່ອງຂໍ້ມູນ.

ການຊິ້ງຄ໌ ແລະ asyncio

ແຕ່ລະການດຳເນີນງານມີຟັງຊັນ sync, sync_detailed, asyncio ແລະ asyncio_detailed, ເຊິ່ງຕັ້ງຊື່ຕາມການດຳເນີນງານໃນຮູບແບບ snake case ແລະ ຈັດກຸ່ມຕາມພື້ນທີ່ API ພາຍໃຕ້ zinn_sdk.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 ບໍ່?

ແມ່ນແລ້ວ. ຕິດຕັ້ງ zinn-sdk ຈາກ PyPI ດ້ວຍ pip install zinn-sdk ແລະ ນຳເຂົ້າ zinn_sdk. ມັນເປັນ typed client ທີ່ສ້າງຂຶ້ນຈາກຂໍ້ກຳນົດ OpenAPI ຂອງພວກເຮົາ, ພ້ອມດ້ວຍການເອີ້ນແບບ synchronous ແລະ asyncio.

ຈຸດສິ້ນສຸດທີ່ກຳນົດໄວ້ຢູ່ໃນ Python SDK ຢູ່ໃສ?

ການດຳເນີນການຕ່າງໆຖືກຈັດກຸ່ມຕາມພື້ນທີ່ API ພາຍໃຕ້ zinn_sdk.api ແລະ ຖືກຕັ້ງຊື່ຕາມລະຫັດປະຕິບັດການ (operation id) ຂອງພວກມັນໃນຮູບແບບ snake case. ຕົວຢ່າງ, ການສະແດງລາຍຊື່ເວັບໄຊແມ່ນ zinn_sdk.api.hosting.list_sites.

ເວີຊັນ Python ໃດແດ່ທີ່ຮອງຮັບ?

Python 3.11 ແລະ ໃໝ່ກວ່າ.

ສຳຫຼວດທຸກຈຸດສິ້ນສຸດ

ທຸກໆການດຳເນີນງານທີ່ SDK ສາມາດຮຽກໃຊ້ໄດ້ແມ່ນໄດ້ຖືກອະທິບາຍໄວ້ໃນເອກະສານອ້າງອີງ API, ພ້ອມກັບພາລາມິເຕີ, ການຕອບກັບ ແລະ ສິດການອະນຸຍາດຂອງມັນ.

ເອກະສານອ້າງອີງ API