RiskWatch API

Dokumentacja

v1https://api.riskwatch.pl/v1

OpenAPI 3.1

Kompletna, testowana kontraktowo specyfikacja jest serwowana przez samo API. Przed wydaniem `npm run test:openapi` sprawdza, że trasy w specyfikacji i w tablicy tras aplikacji są te same (w obie strony) i że każda uwierzytelniona operacja dokumentuje odpowiedzi 401 i 429; nie porównuje schematów modeli błędów.

Pobierz specyfikację
curl https://api.riskwatch.pl/v1/openapi.json

Wygeneruj klienta narzędziem, którego używasz, albo sięgnij po SDK TypeScript z workspace packages/sdk, który pokrywa każdy publiczny endpoint typowanymi błędami i helperami stronicowania.

npm (@riskwatch/sdk)
npm install https://riskwatch.pl/sdk/riskwatch-sdk-1.0.0.tgz
sdk.mjs
import { RiskWatchClient } from "@riskwatch/sdk";

const rw = new RiskWatchClient({
  baseUrl: "https://api.riskwatch.pl/v1",
  apiKey: process.env.RISKWATCH_API_KEY
});

const risk = await rw.getRisk("<YOUR_VALID_NIP>");