API، SDK و CLI

نشانی و دسترسی

نشانی API ابر https://cloud.sarovi.ir/v1 است. کلید را در کنسول توسعه‌دهندگان بسازید. برای خواندن cloud:read، انتشار cloud:hosting، تغییر داده cloud:write و تابع cloud:functions لازم است. کلید را فقط در سرور یا ترمینال نگه دارید. قرارداد کامل در /cloud-openapi.json در دسترس است.

خط فرمان

بستهٔ پیش‌نمایش را از /sdk/sarovi-cloud-cli-0.4.3.tgz دریافت کنید. این بسته هنوز در رجیستری npm منتشر نشده است. SAROVI_API_KEY را در محیط تنظیم کنید؛ از قراردادن کلید در فایل پروژه خودداری کنید.

npm install -g ./sarovi-cloud-cli-0.4.3.tgz
sarovi-cloud catalog
sarovi-cloud init --name my-site --slug my-site
sarovi-cloud deploy --project PROJECT_ID --dir ./dist --yes
sarovi-cloud projects

پیش‌نمایش و انتشار

CLI پوشهٔ خروجی ساخته‌شده را می‌فرستد. پیش‌نمایش عمومی است؛ --yes این انتشار را تأیید می‌کند. بعد از آماده‌شدن نسخه، با promote آن را به سایت اصلی منتقل کنید. پس از قطع ارتباط، ابتدا وضعیت را بررسی کنید؛ ساخت خودکار تکرار نمی‌شود.

sarovi-cloud logs --project PROJECT_ID --deployment DEPLOYMENT_ID
sarovi-cloud promote --project PROJECT_ID --deployment DEPLOYMENT_ID --yes

TypeScript

نسخهٔ Cloud از همان SDK ساروی و کلیدهای پروژه استفاده می‌کند. بستهٔ دانلودی در /sdk/sarovi-sdk-0.1.8.tgz است.

import { SaroviCloud } from '@sarovi/sdk';
const client = new SaroviCloud(); // SAROVI_API_KEY
const catalog = await client.cloud.catalog();
const sites = await client.cloud.hosting.list();

Python

بستهٔ /sdk/sarovi_sdk-0.1.8.tar.gz را نصب کنید. درخواست‌ها خودکار تکرار نمی‌شوند؛ برای تکرار آگاهانه، همان شناسهٔ idempotency را نگه دارید.

from sarovi import SaroviCloud
with SaroviCloud() as client:
    print(client.cloud.catalog())
    print(client.cloud.hosting.list())

محدودهٔ پروژه

سایت ساخته‌شده با API فقط برای کلیدهای همان پروژهٔ API قابل مدیریت است. کلید جدید به‌طور خودکار به سایت‌های کنسول یا پروژه‌های API دیگر دسترسی نمی‌گیرد. سهمیهٔ میزبانی بین پروژه‌های یک حساب مشترک است.