@zinn-digital/sdk என்பது npm-இல் வெளியிடப்பட்ட Zinn Digital® API-க்கான எங்களின் அதிகாரப்பூர்வ TypeScript கிளையன்ட் ஆகும். இதிலுள்ள ஒவ்வொரு பாதையும், அளவுருவும் மற்றும் பதிலும் இந்த API கட்டமைக்கப்பட்டுள்ள அதே OpenAPI விவரக்குறிப்பிலிருந்தே உருவாக்கப்படுகின்றன, மேலும் அந்த விவரக்குறிப்பு மாறும்போதெல்லாம் ஒரு புதிய பதிப்பு தானாகவே வெளியிடப்படும். இந்த வழிகாட்டி அதை நிறுவி, அங்கீகரித்து, உங்களுடைய முதல் அழைப்புகளைச் செய்கிறது.
நிறுவுதல்
npm install @zinn-digital/sdk
இது fetch உள்ள எந்தவொரு JavaScript இயக்க நேரத்திலும் செயல்படும்: Node.js, உலாவி மற்றும் edge இயக்க நேரங்கள். இது 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 என்பது இறுதிப்புள்ளிக்குத் தேவையான அனுமதியை விசை கொண்டிருக்கவில்லை என்பதைக் குறிக்கிறது — கூடுதல் அனுமதிகள் கொண்ட ஒன்றை மீண்டும் பயன்படுத்துவதற்குப் பதிலாக அந்த அனுமதியுடன் ஒரு விசையை உருவாக்குங்கள்.
அடுத்து எங்கு செல்ல வேண்டும்
- எங்கள் வலைத்தளத்தில் உள்ள வழிகாட்டி: zinndigital.com/developers/sdk-typescript
- ஒவ்வொரு இறுதிப்புள்ளி, அதன் அளவுருக்கள் மற்றும் அதன் அனுமதி: zinndigital.com/developers/api
- npm இல் உள்ள தொகுப்பு: npmjs.com/package/@zinn-digital/sdk