TypeScript SDK

Ka maamul martigelintaada TypeScript

@zinn-digital/sdk waa macmiil si buuxda loo teebiyay oo loogu talagalay Zinn Digital® API. Waddo kasta, halbeeg kasta iyo jawaab kasta waxaa laga soo saaray isla caddaynta OpenAPI ee API-ga laga dhisay, markaa tifaftirahaagu wuu yaqaannaa dhammaan API-ga, qalad qoraalna waa qalad isu-dubbarid.

Dhammaan dukumentiyada horumariyaha →

Geli

Xirmadu waxay ku jirtaa npm iyadoo hoos timaada baaxadda @zinn-digital. Waxay ku shaqaysaa jawi kasta oo JavaScript ah oo leh fetch.

npm install @zinn-digital/sdk

Bilaabid degdeg ah

Liis garee gobollada martigelinta dadweynaha adigoon fure wadan, ka dibna ku liis garee bogaggaaga mid.

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);

Xaqiijinta

Barta dhammaadka buug-yaraha guud, sida gobollada iyo qorshayaasha, uma baahna aqoonsi. Wax kasta oo kale waxay adeegsadaan fure API oo hay'ad kasta ah oo loo diro sidii bearer token. Furuhu wuxuu wataa oo keliya oggolaanshaha aad siisay markaad abuurtay, waxaadna burin kartaa wakhti kasta. Ku hay doorsoomaha deegaanka ama kaydkaaga sirta, marnaba ha ku kaydin koodhka isha.

Ka samee furaha API dashboard-kaaga

Waxa aad helayso

Dhammaan API-ga guud, oo la noocyeeyay

Bogagga, xayndaabyada iyo DNS, biilasha, taageerada iyo aag kasta oo kale oo ka mid ah API-ga guud. Jawaabaha iyo khaladaadka waa la nooceeyay, noocyada nidaamkana waxaa loo dhoofiyay koodhkaaga.

Si toos ah loo sameeyay, waligeedna gacanta laguma qorin

Macmiilku waa openapi-fetch oo ku dul shaqeeya noocyada laga soo saaray qeexitaankayaga OpenAPI. Nooc cusub ayaa si toos ah loo daabacaa mar kasta oo qeexitaanku isbeddelo, sidaas darteed barta cusub waxay gaartaa SDK iyada oo aan qofna qorin duub (wrapper).

Yar oo ku-tiirsanaan yar

Hal ku-tiirsanaanta xilliga shaqada ah iyo fetch u gaar ah. Waxay ku shaqaysaa Node.js, birawsarka iyo deegaannada edge, waxaana lagu ruqsadeeyay MIT.

Ilaa hoos loo qoray

Akhri diiwaannada DNS ee godomain-ka oo ku kala saar nooca diiwaanka ee qeexitaanku tilmaamayo.

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);

Xiriirinta

Su'aalo

Ma leedahay TypeScript ama JavaScript SDK?

Haa. Ka rakib @zinn-digital/sdk npm. Waa macmiil si buuxda loo qoray oo laga soo saaray qeexitaankayaga OpenAPI, wuxuuna daboolayaa dhammaan API-ga guud.

Sideen isu xaqiijiyaa?

Ka samee furaha API bogga Furayaasha API ee dashboard-kaaga oo ugu dir ahaan bearer token gudaha madaxa Authorization. Barta dhammaadka buug-yaraha dadweynaha uma baahna fure.

Sidee SDK-ga loogala socodsiyaa mid casri ah?

Waxaa laga soo saaray isla qeexitaanka OpenAPI ee API-ga laga dhisay, waxaana si toos ah loo daabacaa nuqul cusub mar kasta oo qeexitaankaasi isbeddelo.

Sahami barta kasta oo dhammaadka ah

Hawlgal kasta oo SDK-gu wici karo waxaa lagu sharxay tixraaca API-ga, iyadoo ay la socdaan xuduudihiisa, jawaabaha, iyo oggolaanshaha.

Xog-raaca API