TypeScript SDK (@zinn-digital/sdk) નો ઉપયોગ કરવો

@zinn-digital/sdk એ Zinn Digital® API માટેનો અમારો સત્તાવાર TypeScript ક્લાયન્ટ છે, જે npm પર પ્રકાશિત થયેલ છે. તેમાંનો દરેક પાથ, પેરામીટર અને પ્રતિસાદ તે જ OpenAPI સ્પષ્ટીકરણમાંથી જનરેટ કરવામાં આવે છે જેના પરથી API બનાવવામાં આવ્યું છે, અને જ્યારે પણ તે સ્પષ્ટીકરણ બદલાય છે ત્યારે આપમેળે એક નવું વર્ઝન પ્રકાશિત થાય છે. આ માર્ગદર્શિકા તેને ઇન્સ્ટોલ કરે છે, તેને પ્રમાણિત કરે છે અને તમારા પ્રથમ કૉલ્સ કરે છે.

ઇન્સ્ટોલ કરો

npm install @zinn-digital/sdk

તે કોઈપણ JavaScript રનટાઇમમાં કામ કરે છે જેમાં fetch છે: Node.js, બ્રાઉઝર અને એજ રનટાઇમ્સ. તેની એક રનટાઇમ નિર્ભરતા છે, 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