Python SDK
Python ਤੋਂ ਆਪਣੀ ਹੋਸਟਿੰਗ ਦਾ ਪ੍ਰਬੰਧਨ ਕਰੋ
zinn-sdk Zinn Digital® API ਲਈ ਇੱਕ ਟਾਈਪ ਕੀਤਾ Python ਕਲਾਇੰਟ ਹੈ, ਜੋ ਉਸੇ OpenAPI ਨਿਰਧਾਰਨ ਤੋਂ ਤਿਆਰ ਕੀਤਾ ਗਿਆ ਹੈ ਜਿਸ ਤੋਂ API ਬਣਾਇਆ ਗਿਆ ਹੈ। ਹਰੇਕ ਕਾਰਵਾਈ ਵਿੱਚ ਸਮਕਾਲੀ ਅਤੇ 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 ਖੇਤਰ ਦੁਆਰਾ ਸਮੂਹਬੱਧ ਕੀਤਾ ਗਿਆ ਹੈ ਅਤੇ ਉਹਨਾਂ ਦੇ ਓਪਰੇਸ਼ਨ ਆਈਡੀ ਦੇ ਅਧਾਰ ਤੇ snake case ਵਿੱਚ ਨਾਮ ਦਿੱਤਾ ਗਿਆ ਹੈ। ਉਦਾਹਰਨ ਲਈ, ਸਾਈਟਾਂ ਨੂੰ ਸੂਚੀਬੱਧ ਕਰਨਾ zinn_sdk.api.hosting.list_sites ਹੈ।
ਕਿਹੜੇ Python ਸੰਸਕਰਣ ਸਮਰਥਿਤ ਹਨ?
Python 3.11 ਅਤੇ ਬਾਅਦ ਵਾਲੇ।
ਹਰੇਕ ਐਂਡਪੁਆਇੰਟ ਦੀ ਪੜਚੋਲ ਕਰੋ
ਹਰੇਕ ਕਾਰਵਾਈ ਜਿਸ ਨੂੰ SDK ਕਾਲ ਕਰ ਸਕਦਾ ਹੈ, ਉਸ ਦੇ ਪੈਰਾਮੀਟਰਾਂ, ਜਵਾਬਾਂ ਅਤੇ ਇਜਾਜ਼ਤਾਂ ਸਮੇਤ API ਹਵਾਲੇ ਵਿੱਚ ਵਰਣਨ ਕੀਤੀ ਗਈ ਹੈ।