TypeScript SDK
TypeScript இலிருந்து உங்கள் ஹோஸ்டிங்கை நிர்வகிக்கவும்
@zinn-digital/sdk என்பது Zinn Digital® API க்கான முழுமையான தட்டச்சு செய்யப்பட்ட கிளையன்ட் ஆகும். API உருவாக்கப்பட்டுள்ள அதே OpenAPI விவரக்குறிப்பிலிருந்தே ஒவ்வொரு பாதையும், அளவுருவும் மற்றும் பதிலும் உருவாக்கப்படுகின்றன, எனவே உங்கள் எடிட்டருக்கு முழு API-யும் தெரியும் மற்றும் தட்டச்சுப் பிழை ஒரு கம்பைல் பிழையாக மாறும்.
நிறுவு
தொகுப்பு @zinn-digital வரம்பின் கீழ் npm இல் உள்ளது. இது fetch உள்ள எந்தவொரு JavaScript இயக்கநேர சூழலிலும் இயங்குகிறது.
npm install @zinn-digital/sdkவிரைவுத் தொடக்கம்
ஒரு விசை இல்லாமல் பொது ஹோஸ்டிங் பகுதிகளைப் பட்டியலிடுங்கள், பின்னர் அதைக் கொண்டு உங்கள் சொந்த தளங்களைப் பட்டியலிடுங்கள்.
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);அங்கீகரிப்பு
பிராந்தியங்கள் மற்றும் திட்டங்கள் போன்ற பொதுப் பட்டியல் எண்ட்பாயிண்ட்டுகளுக்கு எந்த நற்சான்றிதழும் தேவையில்லை. மற்றவை அனைத்தும் bearer token ஆக அனுப்பப்படும் ஒரு நிறுவனத்திற்கான API விசையைப் பயன்படுத்துகின்றன. நீங்கள் ஒரு விசையை உருவாக்கும்போது அதற்கு வழங்கும் அனுமதிகளை மட்டுமே அது கொண்டிருக்கும், மேலும் அதை நீங்கள் எப்போது வேண்டுமானாலும் திரும்பப் பெறலாம். அதை ஒரு சுற்றுச்சூழல் மாறியில் அல்லது உங்கள் ரகசிய சேமிப்பகத்தில் வைத்திருங்கள், மூலக் குறியீட்டில் ஒருபோதும் வைக்க வேண்டாம்.
நீங்கள் பெறுபவை
முழு பொது API-யும், வகைப்படுத்தப்பட்டது
தளங்கள், டொமைன்கள் மற்றும் DNS, பில்லிங், ஆதரவு மற்றும் பொது API-இன் பிற பகுதிகள் அனைத்தும். பதில்கள் மற்றும் பிழைகள் வகைப்படுத்தப்பட்டுள்ளன, மேலும் உங்கள் சொந்தக் குறியீட்டிற்காக ஸ்கீமா வகைகள் ஏற்றுமதி செய்யப்படுகின்றன.
உருவாக்கப்பட்டது, ஒருபோதும் கையால் எழுதப்படவில்லை
கிளையன்ட் என்பது எங்கள் OpenAPI விவரக்குறிப்பிலிருந்து உருவாக்கப்பட்ட வகைகளின் மீதான openapi-fetch ஆகும். விவரக்குறிப்பு மாறும் போதெல்லாம் ஒரு புதிய பதிப்பு தானாகவே வெளியிடப்படுகிறது, எனவே யாரும் ஒரு ரேப்பரை எழுதாமலேயே ஒரு புதிய முனைப்புள்ளி SDK-ஐ சென்றடைகிறது.
சிறியது மற்றும் குறைந்த சார்புகள் கொண்டது
இயக்க நேரச் சார்பு ஒன்றும் சொந்த fetch வசதியும் கொண்டது. இது Node.js, உலாவி மற்றும் எட்ஜ் இயக்க நேர சூழல்களில் இயங்குகிறது, மேலும் இது MIT-உரிமம் பெற்றது.
கீழ் வரை தட்டச்சு செய்யப்பட்டது
ஒரு டொமைனின் DNS பதிவுகளைப் படித்து, விவரக்குறிப்பு வரையறுக்கும் பதிவு வகையைக் கொண்டு அவற்றை வடிகட்டவும்.
import type { components } from "@zinn-digital/sdk";
type DnsRecord = components["schemas"]["DnsRecord"];
// Paths, parameters and responses are all typed from the OpenAPI spec:
// a misspelt query parameter is a compile error, not a silent no-op.
const { data: records } = await api.GET("/v1/domains/{domainId}/dns/records", {
params: { path: { domainId: "YOUR_DOMAIN_ID" } },
});
const txt: DnsRecord[] = (records?.data ?? []).filter((r) => r.type === "TXT");
for (const record of txt) console.log(record.name, record.value);கேள்விகள்
உங்களிடம் TypeScript அல்லது JavaScript SDK உள்ளதா?
ஆம். npm இலிருந்து @zinn-digital/sdk ஐ நிறுவவும். இது எங்கள் OpenAPI விவரக்குறிப்பிலிருந்து உருவாக்கப்பட்ட முழுமையாக தட்டச்சு செய்யப்பட்ட கிளையன்ட் ஆகும், மேலும் இது முழு பொது API ஐயும் உள்ளடக்கியது.
நான் எவ்வாறு அங்கீகரிப்பது?
உங்கள் டாஷ்போர்டின் API விசைகள் பக்கத்தில் ஓர் API விசையை உருவாக்கி, அதை Authorization தலைப்பில் ஒரு பேரியர் டோக்கனாக அனுப்பவும். பொது அட்டவணை இறுதிப் புள்ளிகளுக்கு விசை தேவையில்லை.
SDK எவ்வாறு புதுப்பித்த நிலையில் வைத்திருக்கப்படுகிறது?
API கட்டமைக்கப்பட்ட அதே OpenAPI விவரக்குறிப்பிலிருந்து இது உருவாக்கப்படுகிறது, மேலும் அந்த விவரக்குறிப்பு மாறும்போதெல்லாம் புதிய பதிப்பு தானாகவே வெளியிடப்படும்.
ஒவ்வொரு முனைப்புள்ளியையும் ஆராயுங்கள்
SDK அழைக்கக்கூடிய ஒவ்வொரு செயல்பாடும் அதன் அளவுருக்கள், பதில்கள் மற்றும் அனுமதிகளுடன் API குறிப்பில் விவரிக்கப்பட்டுள்ளது.