SDK TypeScript

Drejtoni hostimin tuaj nga TypeScript

@zinn-digital/sdk është një klient i tipizuar plotësisht për Zinn Digital® API. Çdo shteg, parametër dhe përgjigje gjenerohet nga i njëjti specifikim OpenAPI nga i cili është ndërtuar API, kështu që redaktuesi juaj e njeh të gjithë API-n dhe një gabim shkrimi përbën një gabim kompilimi.

I gjithë dokumentacioni i zhvilluesit →

Instalo

Paketa gjendet në npm nën fushëveprimin @zinn-digital. Ajo funksionon në çdo mjedis ekzekutimi JavaScript që ka fetch.

npm install @zinn-digital/sdk

Fillim i shpejtë

Rreshtoni rajonet publike të pritjes pa një çelës, pastaj rreshtoni faqet tuaja me një të tillë.

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

Autentifikimi

Pikat përfundimtare të katalogut publik, të tilla si rajonet dhe planet, nuk kërkojnë kredenciale. Çdo gjë tjetër përdor një çelës API për çdo organizatë të dërguar si bearer token. Një çelës mbart vetëm lejet që i jepni kur e krijoni atë dhe mund ta revokoni në çdo kohë. Mbajeni atë në një variabël mjedisi ose në ruajtjen tuaj të sekreteve, asnjëherë në kodin burimor.

Krijoni një çelës API në panelin tuaj

Çfarë përfitoni

I gjithë API publik, i tipizuar

Faqet, domenet dhe DNS, faturimi, mbështetja dhe çdo fushë tjetër e API-së publike. Përgjigjet dhe gabimet janë të tipizuara, dhe llojet e skemave eksportohen për kodin tuaj.

E gjeneruar, asnjëherë e shkruar me dorë

Klienti është openapi-fetch mbi llojet e gjeneruara nga specifikimi ynë OpenAPI. Një version i ri publikohet automatikisht sa herë që specifikimi ndryshon, kështu që një pikë e re fundore mbërrin në SDK pa pasur nevojë që dikush të shkruajë një mbështjellës.

I vogël dhe me pak varësi

Një varësi e vetme gjatë ekzekutimit dhe fetch vendas. Punon në Node.js, në shfletues dhe në mjediset e ekzekutimit edge, si dhe është i licencuar me MIT.

E shkruar deri në fund

Lexoni regjistrimet DNS të një domeni dhe filtrojini ato sipas llojit të regjistrimit që përcakton specifikimi.

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

Lidhjet

Pyetje

A keni një SDK për TypeScript ose JavaScript?

Po. Instaloni @zinn-digital/sdk nga npm. Është një klient plotësisht i tipizuar i krijuar nga specifikimi ynë OpenAPI dhe mbulon të gjithë API-n publik.

Si të autentifikohem?

Krijoni një çelës API në faqen Çelësat API të panelit tuaj dhe dërgojeni atë si një token mbajtës në kryetitullin Authorization. Pikat fundore të katalogut publik nuk kanë nevojë për çelës.

Si mbahet SDK-ja e përditësuar?

Gjenerohet nga i njëjti specifikim OpenAPI nga i cili është ndërtuar API-ja, dhe një version i ri publikohet automatikisht sa herë që ai specifikim ndryshon.

Eksploroni çdo pikë fundore

Çdo veprim që SDK-ja mund të thërrasë përshkruhet në dokumentacionin e referencës së API-së, së bashku me parametrat, përgjigjet dhe lejet e tij.

Referenca e API-t