Python Quickstart

Deze gids helpt u om u te authenticeren bij de VaultPAM API en uw eerste verzoek in te dienen met Python.

Vereisten:

• Python 3.8 of later
• requests-bibliotheek: pip install requests
• Een VaultPAM-account met ingeschakelde API-toegang

---

Stap 1 — Installeer de requests-bibliotheek

pip install requests

---

Stap 2 — Authenticeer

import getpass
import os
import requests

BASE_URL = os.environ.get("VAULTPAM_BASE_URL", "https://api.vaultpam.com")

email = input("Email: ")
password = getpass.getpass("Password: ")  # Never commit credentials to source control

response = requests.post(
    f"{BASE_URL}/api/v1/auth/login",
    json={"email": email, "password": password},
)
response.raise_for_status()

auth_data = response.json()
# Never commit — see auth-flow.md#token-storage
token = auth_data["access_token"]
expires_in = auth_data["expires_in"]
print(f"Authenticated. Token expires in {expires_in} seconds.")

Voer tokens nooit in

Bewaar token in een secrets manager of omgevingsvariabele — voer nooit hardcoded referenties in. Zie Token Storage.

---

Stap 3 — Haal uw actieve organisatie op

org_response = requests.get(
    f"{BASE_URL}/api/v1/org/memberships",
    headers={"Authorization": f"Bearer {token}"},
)
org_response.raise_for_status()

org_data = org_response.json()
org_id = org_data["active_org_id"]
print(f"Active org: {org_id}")

---

Stap 4 — Vermeld uw safes

safes_response = requests.get(
    f"{BASE_URL}/api/v1/safes",
    headers={
        "Authorization": f"Bearer {token}",
        "X-Active-Org-Id": org_id,
    },
)
safes_response.raise_for_status()

safes = safes_response.json()
print(f"Found {len(safes)} safe(s):")
for safe in safes:
    print(f"  - {safe.get('name', safe.get('id'))}")

---

Volledig voorbeeld

import getpass
import os
import sys
import requests

BASE_URL = os.environ.get("VAULTPAM_BASE_URL", "https://api.vaultpam.com")


def get_session(base_url: str) -> tuple[str, str]:
    """Authenticate and return (token, org_id)."""
    email = input("Email: ")
    password = getpass.getpass("Password: ")  # Never commit — see auth-flow.md#token-storage

    resp = requests.post(f"{base_url}/api/v1/auth/login", json={"email": email, "password": password})
    resp.raise_for_status()
    token = resp.json()["access_token"]

    org_resp = requests.get(f"{base_url}/api/v1/org/memberships", headers={"Authorization": f"Bearer {token}"})
    org_resp.raise_for_status()
    org_id = org_resp.json()["active_org_id"]

    return token, org_id


def list_safes(base_url: str, token: str, org_id: str) -> list:
    resp = requests.get(
        f"{base_url}/api/v1/safes",
        headers={"Authorization": f"Bearer {token}", "X-Active-Org-Id": org_id},
    )
    resp.raise_for_status()
    return resp.json()


if __name__ == "__main__":
    try:
        token, org_id = get_session(BASE_URL)
        safes = list_safes(BASE_URL, token, org_id)
        print(f"Safes ({len(safes)}):")
        for s in safes:
            print(f"  {s.get('name', s.get('id'))}")
    except requests.HTTPError as exc:
        print(f"API error {exc.response.status_code}: {exc.response.text}", file=sys.stderr)
        sys.exit(1)

---

Foutafhandeling

raise_for_status() genereert requests.HTTPError op 4xx/5xx-antwoorden. Ga naar exc.response.status_code en exc.response.text voor details:

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

---

Bewustzijn van tariefslimieten

response = requests.get(
    f"{BASE_URL}/api/v1/safes",
    headers={"Authorization": f"Bearer {token}", "X-Active-Org-Id": org_id},
)
remaining = response.headers.get("x-ratelimit-remaining")
print(f"Rate limit remaining: {remaining}")

Zie Rate Limits voor backoff-strategieën.

---

Volgende stappen

• Authentication Flow — volledige tokencyclus, PATs en beveiligde opslag
• curl Quickstart — dezelfde flow met behulp van de opdrachtregel
• TypeScript Quickstart — dezelfde flow met behulp van Node.js
• Rate Limits — inzicht in x-ratelimit-*-headers