curl Quickstart

Deze handleiding leidt u door het authenticeren bij de VaultPAM API en het uitvoeren van uw eerste aanvraag met curl.

Vereisten:

• curl geïnstalleerd (versie 7.58 of hoger)
• jq geïnstalleerd (voor het parseren van JSON-antwoorden — optioneel maar aanbevolen)
• Een VaultPAM-account met API-toegang ingeschakeld

---

Stap 1 — Stel uw basis-URL in

export VAULTPAM_BASE_URL="https://api.vaultpam.com"

Vervang de waarde door uw werkelijke VaultPAM controleplan-URL als u een zelfgehoste implementatie gebruikt.

---

Stap 2 — Authenticatie

# Lees gegevens veilig in — commit tokens nooit naar broncodebeheer (zie auth-flow.md#token-storage)
read -p "Email: " VAULTPAM_EMAIL
read -s -p "Password: " VAULTPAM_PASSWORD
echo

RESPONSE=$(curl --silent --fail-with-body \
  --url "${VAULTPAM_BASE_URL}/api/v1/auth/login" \
  --header "Content-Type: application/json" \
  --data "{\"email\": \"${VAULTPAM_EMAIL}\", \"password\": \"${VAULTPAM_PASSWORD}\"}")

# Extraheer het toegangstoken
VAULTPAM_TOKEN=$(echo "${RESPONSE}" | jq -r '.access_token')
echo "Authenticated. Token expires in $(echo "${RESPONSE}" | jq '.expires_in') seconds."

Tokens nooit committen

Sla VAULTPAM_TOKEN op in een omgevingsvariabele of secrets manager — hardcodeer het nooit in scripts. Zie Token Storage.

---

Stap 3 — Haal uw actieve organisatie op

ORG_RESPONSE=$(curl --silent --fail-with-body \
  --url "${VAULTPAM_BASE_URL}/api/v1/org/memberships" \
  --header "Authorization: Bearer ${VAULTPAM_TOKEN}")

VAULTPAM_ORG_ID=$(echo "${ORG_RESPONSE}" | jq -r '.active_org_id')
echo "Active org: ${VAULTPAM_ORG_ID}"

---

Stap 4 — Vermeld uw safes

curl --silent --fail-with-body \
  --url "${VAULTPAM_BASE_URL}/api/v1/safes" \
  --header "Authorization: Bearer ${VAULTPAM_TOKEN}" \
  --header "X-Active-Org-Id: ${VAULTPAM_ORG_ID}" \
  | jq '.'

Een succesvol antwoord retourneert een JSON-array van safeobjecten.

---

Foutafhandeling

curl --fail-with-body sluit af met een code anders dan nul bij HTTP 4xx/5xx-antwoorden en drukt de antwoordtekst af. Wikkelt uw aanroepen in foutkontroledoppen:

if ! SAFES=$(curl --silent --fail-with-body \
  --url "${VAULTPAM_BASE_URL}/api/v1/safes" \
  --header "Authorization: Bearer ${VAULTPAM_TOKEN}" \
  --header "X-Active-Org-Id: ${VAULTPAM_ORG_ID}"); then
  echo "Request failed: ${SAFES}" >&2
  exit 1
fi
echo "${SAFES}" | jq '.'

Veelvoorkomende statuscodes:

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

---

Begrenzingstariefbewustzijn

Controleer de responsheaders om uw budget te controleren:

curl --silent --fail-with-body --include \
  --url "${VAULTPAM_BASE_URL}/api/v1/safes" \
  --header "Authorization: Bearer ${VAULTPAM_TOKEN}" \
  --header "X-Active-Org-Id: ${VAULTPAM_ORG_ID}" \
  | grep -i "x-ratelimit"

Zie Rate Limits voor details over backoff-strategieën.

---

Volgende stappen

• Authentication Flow — volledige tokenlevenscyclus, PATs en veilige opslag
• Python Quickstart — dezelfde stroom met Python
• TypeScript Quickstart — dezelfde stroom met Node.js
• Rate Limits — begrijp x-ratelimit-* headers