TypeScript Quickstart

Deze handleiding begeleidt u stap voor stap door verificatie bij de VaultPAM API en het maken van uw eerste aanvraag met behulp van TypeScript en de native fetch API (Node.js 18+).

Vereisten:

• Node.js 18 of hoger (ingebouwde fetch API)
• TypeScript 5.x (optioneel — de voorbeelden werken ook als gewoon JavaScript)
• Een VaultPAM-account met API-toegang ingeschakeld

---

Stap 1 — Stel uw omgeving in

# Stel uw basis-URL in via omgevingsvariabelen — nooit hardcoderen in broncode
export VAULTPAM_BASE_URL="https://api.vaultpam.com"
export VAULTPAM_TOKEN="<your-token>"  # Nooit committen — zie auth-flow.md#token-storage

Voor productie-integraties laadt u deze waarden vanuit een secrets manager of een .env-bestand dat in .gitignore is opgenomen.

---

Stap 2 — Verifiëren

const BASE_URL = process.env.VAULTPAM_BASE_URL ?? "https://api.vaultpam.com";

interface AuthResponse {
  access_token: string;
  expires_in: number;
}

async function login(email: string, password: string): Promise<AuthResponse> {
  const response = await fetch(`${BASE_URL}/api/v1/auth/login`, {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({ email, password }),
  });

  if (!response.ok) {
    throw new Error(`Login failed: ${response.status} ${await response.text()}`);
  }

  return response.json() as Promise<AuthResponse>;
}

// Laad referenties vanuit omgevingsvariabelen — nooit committen naar broncodebeheer (zie auth-flow.md#token-storage)
const email = process.env.VAULTPAM_EMAIL ?? "";
const password = process.env.VAULTPAM_PASSWORD ?? "";

const { access_token: token, expires_in: expiresIn } = await login(email, password);
console.log(`Authenticated. Token expires in ${expiresIn} seconds.`);

Committen van tokens nooit

Laad VAULTPAM_TOKEN vanuit process.env of een secrets manager — nooit hardcode-referenties. Zie Token Storage.

---

Stap 3 — Haal uw actieve organisatie op

interface OrgMembershipsResponse {
  active_org_id: string;
  memberships: Array<{ org_id: string; role: string }>;
}

async function getActiveOrgId(token: string): Promise<string> {
  const response = await fetch(`${BASE_URL}/api/v1/org/memberships`, {
    headers: { Authorization: `Bearer ${token}` },
  });

  if (!response.ok) {
    throw new Error(`Failed to get org memberships: ${response.status}`);
  }

  const data = (await response.json()) as OrgMembershipsResponse;
  return data.active_org_id;
}

const orgId = await getActiveOrgId(token);
console.log(`Active org: ${orgId}`);

---

Stap 4 — Geef uw safes weer

interface Safe {
  id: string;
  name: string;
}

async function listSafes(token: string, orgId: string): Promise<Safe[]> {
  const response = await fetch(`${BASE_URL}/api/v1/safes`, {
    headers: {
      Authorization: `Bearer ${token}`,
      "X-Active-Org-Id": orgId,
    },
  });

  if (!response.ok) {
    throw new Error(`Failed to list safes: ${response.status} ${await response.text()}`);
  }

  return response.json() as Promise<Safe[]>;
}

const safes = await listSafes(token, orgId);
console.log(`Found ${safes.length} safe(s):`);
safes.forEach((s) => console.log(`  - ${s.name}`));

---

Volledig voorbeeld

const BASE_URL = process.env.VAULTPAM_BASE_URL ?? "https://api.vaultpam.com";

// Laad vanuit omgevingsvariabelen — nooit committen naar broncodebeheer (zie auth-flow.md#token-storage)
const email = process.env.VAULTPAM_EMAIL ?? "";
const password = process.env.VAULTPAM_PASSWORD ?? "";

async function main(): Promise<void> {
  // Stap 1: Verifiëren
  const loginResp = await fetch(`${BASE_URL}/api/v1/auth/login`, {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({ email, password }),
  });
  if (!loginResp.ok) throw new Error(`Login failed: ${loginResp.status}`);
  const { access_token: token } = (await loginResp.json()) as { access_token: string };

  // Stap 2: Haal actieve organisatie op
  const orgResp = await fetch(`${BASE_URL}/api/v1/org/memberships`, {
    headers: { Authorization: `Bearer ${token}` },
  });
  if (!orgResp.ok) throw new Error(`Org lookup failed: ${orgResp.status}`);
  const { active_org_id: orgId } = (await orgResp.json()) as { active_org_id: string };

  // Stap 3: Geef safes weer
  const safesResp = await fetch(`${BASE_URL}/api/v1/safes`, {
    headers: {
      Authorization: `Bearer ${token}`,
      "X-Active-Org-Id": orgId,
    },
  });
  if (!safesResp.ok) throw new Error(`Safes request failed: ${safesResp.status}`);
  const safes = (await safesResp.json()) as Array<{ id: string; name: string }>;
  console.log(`Safes (${safes.length}):`);
  safes.forEach((s) => console.log(`  ${s.name}`));
}

main().catch((err) => {
  console.error(err);
  process.exit(1);
});

---

Foutafhandeling

Alle fetch-aanroepen controleren response.ok en geven een fout weer bij mislukking. Veel voorkomende statuscodes:

Code	Betekenis
401 Unauthorized	Token ontbreekt, is verlopen of ongeldig. Verifieer opnieuw.
403 Forbidden	Token heeft niet de vereiste bereik voor dit eindpunt.
429 Too Many Requests	Snelheidslimiet overschreden. Controleer de retry-after-header.
500 Internal Server Error	Voorbijgaande serverfout. Probeer opnieuw met backoff.

---

Bewustzijn van snelheidslimiet

const response = await fetch(`${BASE_URL}/api/v1/safes`, {
  headers: { Authorization: `Bearer ${token}`, "X-Active-Org-Id": orgId },
});

const remaining = response.headers.get("x-ratelimit-remaining");
console.log(`Rate limit remaining: ${remaining}`);

Zie Rate Limits voor backoff-strategieën.

---

Volgende stappen

• Authentication Flow — volledige token-levenscyclus, PATs en veilige opslag
• curl Quickstart — dezelfde stroom met behulp van de opdrachtregel
• Python Quickstart — dezelfde stroom met behulp van Python
• Rate Limits — begrijp x-ratelimit-*-headers