Hopp til innhold
Dokumentasjonsmeny

SDK-er og artefakter

Utviklersettet: TypeScript- og C#-SDK-er, Postman-samlingen og den styrte OpenAPI-kontrakten.

Utviklersettet

Itemra publiserer et versjonert utviklersett generert fra den styrte OpenAPI-kontrakten, med TypeScript-pakken (@itemra/customer-api), .NET-pakken (Itemra.CustomerApi), en Postman-samling gruppert etter ressurs, selve OpenAPI-JSON-en og en endringslogg — med SHA256SUMS for å verifisere hvert artefakt før installasjon.

TypeScript

import { Configuration, ItemsApi } from '@itemra/customer-api'

const items = new ItemsApi(new Configuration({
  basePath: 'https://api.itemra.io',
  accessToken: process.env.ITEMRA_API_KEY,
}))

const result = await items.v1ItemsGet({ limit: 10, sort: 'name' })

Kun tjenerside-kjøretider — en API-nøkkel i en nettleserpakke er en kompromittert nøkkel.

C#

using Itemra.CustomerApi.Api;

var items = host.Services.GetRequiredService<IItemsApi>();
var response = await items.V1ItemsGetAsync();

Pakken kobler bearer-autentisering og typede klienter gjennom standard .NET-vertsbygger; se settets hurtigstart for fullt oppsett.

Postman og OpenAPI

Importer samlingen, pek dens baseUrl mot https://api.itemra.io, og hold bearer-tokenet i et privat miljø — aldri i en eksportert samling. Alt SDK-ene ikke dekker er én generering unna: kontrakten på api.itemra.io/openapi/v1.json er samme fil settet bygges fra, og Scalar viser den interaktivt.