TypeScript SDK (@zinn-digital/sdk) वापरणे

@zinn-digital/sdk हा npm वर प्रकाशित केलेला, Zinn Digital® API साठीचा आमचा अधिकृत TypeScript क्लायंट आहे. यातील प्रत्येक पाथ, पॅरामीटर आणि प्रतिसाद त्याच OpenAPI तपशीलावरून तयार केला जातो ज्यावरून API तयार केले आहे, आणि जेव्हा जेव्हा तो तपशील बदलतो तेव्हा नवीन आवृत्ती स्वयंचलितपणे प्रकाशित केली जाते. हे मार्गदर्शक ते स्थापित करते, त्याचे प्रमाणीकरण करते आणि तुमचे पहिले कॉल करते.

स्थापित करा

npm install @zinn-digital/sdk

हे fetch असलेल्या कोणत्याही JavaScript रनटाइममध्ये कार्य करते: Node.js, ब्राउझर आणि एज रनटाइम्स. यामध्ये एक रनटाइम अवलंबित्व (dependency), 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 सह हे चालवा. पहिली ओळ होस्टिंग प्रदेश मुद्रित करते, त्यानंतर प्रत्येक साइटसाठी एक ओळ.

तुमच्या स्वतःच्या कोडसाठी प्रकार

स्कीमा प्रकार निर्यात केले जातात, ज्यामुळे तुमची स्वतःची फंक्शन्स API चे आकार वापरू शकतात:

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

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

चुकीचे स्पेलिंग असलेला पाथ, पॅरामीटर किंवा फील्ड ही शांतपणे चुकीची कृती करणाऱ्या विनंतीऐवजी कंपाइल त्रुटी असते.

त्रुटी

प्रत्येक कॉल { data, error, response } मिळवून देतो. नॉन-2xx प्रतिसादावर data अपरिभाषित असतो आणि error हे API चे एरर एनव्हलप असते: error.error.code, मानवाला वाचता येणारा error.error.message आणि प्रमाणीकरण अयशस्वी झाल्यास प्रत्येक फील्डचे नाव देणारा error.error.details. 403 चा अर्थ असा आहे की की (key) कडे एंडपॉइंटसाठी आवश्यक असणारी परवानगी नाही — अधिक परवानगी असलेली की पुन्हा वापरण्याऐवजी ती परवानगी असलेली की तयार करा.

पुढे कुठे जावे

• आमच्या वेबसाइटवरील मार्गदर्शक: zinndigital.com/developers/sdk-typescript
• प्रत्येक एंडपॉइंट, त्याचे पॅरामीटर्स आणि त्याची परवानगी: zinndigital.com/developers/api
• npm वरील पॅकेज: npmjs.com/package/@zinn-digital/sdk