TypeScript SDK (@zinn-digital/sdk) ကို အသုံးပြုခြင်း

@zinn-digital/sdk သည် npm ပေါ်တွင် ထုတ်ဝေထားသော Zinn Digital® API အတွက် ကျွန်ုပ်တို့၏ တရားဝင် TypeScript client ဖြစ်ပါသည်။ ၎င်းရှိ လမ်းကြောင်း၊ ပါရာမီတာနှင့် တုံ့ပြန်မှုတိုင်းကို API တည်ဆောက်ထားသည့် တူညီသော OpenAPI သတ်မှတ်ချက်မှ ထုတ်လုပ်ထားပြီး ထိုသတ်မှတ်ချက် ပြောင်းလဲသည့်အခါတိုင်း ဗားရှင်းအသစ်တစ်ခုကို အလိုအလျောက် ထုတ်ဝေပါသည်။ ဤလမ်းညွှန်ချက်သည် ၎င်းကို ထည့်သွင်းခြင်း၊ အထောက်အထားစိစစ်ခြင်းနှင့် သင်၏ ပထမဆုံး ခေါ်ဆိုမှုများကို ပြုလုပ်ပေးပါသည်။

ထည့်သွင်းပါ

npm install @zinn-digital/sdk

၎င်းသည် fetch ပါရှိသော မည်သည့် JavaScript runtime တွင်မဆို အလုပ်လုပ်ပါသည်- Node.js၊ ဘရောက်ဇာနှင့် edge runtimes တို့ ဖြစ်ပါသည်။ ၎င်းတွင် runtime အမှီအခိုတစ်ခုဖြစ်သော openapi-fetch ပါရှိပြီး MIT လိုင်စင်ရထားပါသည်။

API ကီးတစ်ခု ဖန်တီးပါ

သင့်ဒက်ရှ်ဘုတ်၏ API ကီးများ စာမျက်နှာ (app.zinndigital.com/api-keys) ကို ဖွင့်ပြီး ကီးတစ်ခု ဖန်တီးပါ ကို နှိပ်ပါ။ ကီးအတွက် အမည်တစ်ခုပေးပြီး သင့်ကုဒ် လိုအပ်သော ခွင့်ပြုချက်များကိုသာ ပေးပါ — ဥပမာအားဖြင့် ဆိုက်များကို စာရင်းပြုစုရန်အတွက် sites.view ဖြစ်ပါသည်။ ကီးကို တစ်ကြိမ်သာ ပြသပါမည်။ ၎င်းကို ပတ်ဝန်းကျင် ပြောင်းလဲနိုင်သောတန်ဖိုး သို့မဟုတ် သင့်လျှို့ဝှက်ချက် သိမ်းဆည်းရာနေရာတွင် သိမ်းဆည်းပါ၊ အရင်းအမြစ်ကုဒ်ထဲတွင် လုံးဝမသိမ်းဆည်းပါနှင့်။ သင်သည် ထိုစာမျက်နှာပေါ်တွင်ပင် ကီးကို အချိန်မရွေး ပယ်ဖျက်နိုင်ပါသည်။

ဟိုစတင်း ဒေသများနှင့် အစီအစဉ်များကဲ့သို့သော အများသုံး ကတ်တလောက် အဆုံးမှတ်များသည် မည်သည့်ကီးမျှ လုံးဝမလိုအပ်ပါ။

သင့်ပထမဆုံး ခေါ်ဆိုမှုများ

import { createApiClient } from "@zinn-digital/sdk";

const api = createApiClient({ baseUrl: "https://api.zinndigital.com" });

// Public catalogue endpoints need no key.
const { data: regions } = await api.GET("/v1/catalog/regions");
console.log(regions?.data.map((r) => r.slug));

// Everything else uses a per-organisation API key.
api.use({
  onRequest({ request }) {
    request.headers.set("Authorization", `Bearer ${process.env.ZINN_API_KEY}`);
  },
});

const { data, error } = await api.GET("/v1/sites", { params: { query: { limit: 5 } } });
if (error) throw new Error(error.error.message);
for (const site of data.data) console.log(site.name, site.status);

၎င်းကို ZINN_API_KEY=zdk_live_… npx tsx first-calls.ts ဖြင့် လုပ်ဆောင်ပါ။ ပထမလိုင်းတွင် hosting ဒေသများကို ဖော်ပြပေးမည်ဖြစ်ပြီး၊ ထို့နောက် ဆိုက်တစ်ခုလျှင် တစ်လိုင်းစီ ဖော်ပြပေးမည်ဖြစ်သည်။

သင်၏ကိုယ်ပိုင်ကုဒ်အတွက် အမျိုးအစားများ

Schema အမျိုးအစားများကို ထုတ်ယူပေးထားသောကြောင့် သင်၏ကိုယ်ပိုင် functions များသည် API ၏ ပုံစံများကို အသုံးပြုနိုင်ပါသည်-

import type { components } from "@zinn-digital/sdk";

type Site = components["schemas"]["Site"];
type DnsRecord = components["schemas"]["DnsRecord"];

စာလုံးပေါင်းမှားယွင်းနေသော လမ်းကြောင်း၊ ပါရာမီတာ သို့မဟုတ် ဖိုင်လ်တစ်ခုသည် တိတ်တဆိတ် မှားယွင်းစွာလုပ်ဆောင်သော တောင်းဆိုချက်တစ်ခု ဖြစ်မည့်အစား compile error တစ်ခု ဖြစ်ပါသည်။

အမှားအယွင်းများ

ခေါ်ဆိုမှုတိုင်းသည် { data, error, response } ကို ပြန်ပေးပါသည်။ 2xx မဟုတ်သော တုံ့ပြန်မှုတွင် data သည် undefined ဖြစ်ပြီး error သည် API ၏ အမှားစာအိတ်ဖြစ်သည်- error.error.code၊ လူဖတ်နိုင်သော error.error.message နှင့် အတည်ပြုမှု မအောင်မြင်ခြင်းများအတွက် ဖိုင်လ်တစ်ခုစီကို အမည်သတ်မှတ်ပေးသော error.error.details တို့ ဖြစ်ပါသည်။ 403 သည် အဆိုပါကီးတွင် အဆုံးမှတ် လိုအပ်သော ခွင့်ပြုချက်မရှိဟု အဓိပ္ပာယ်ရပါသည် — ပိုမိုများပြားသော ခွင့်ပြုချက်ပါသည့် ကီးတစ်ခုကို ပြန်လည်အသုံးမပြုဘဲ ထိုခွင့်ပြုချက်ပါရှိသော ကီးတစ်ခုကို ဖန်တီးပါ။

နောက်ထပ် သွားရောက်ရမည့်နေရာများ

• ကျွန်ုပ်တို့၏ ဝဘ်ဆိုက်ရှိ လမ်းညွှန်- zinndigital.com/developers/sdk-typescript
• အဆုံးမှတ်တိုင်း၊ ၎င်း၏ ပါရာမီတာများနှင့် ၎င်း၏ ခွင့်ပြုချက်- zinndigital.com/developers/api
• npm ရှိ ပက်ကေ့ဂျ်- npmjs.com/package/@zinn-digital/sdk