Python-Schnellstart

Diese Anleitung führt Sie durch die Authentifizierung an der VaultPAM-API und das Absetzen Ihrer ersten Anfrage mit Python.

Voraussetzungen:

• Python 3.8 oder höher
• requests-Bibliothek: pip install requests
• Ein VaultPAM-Konto mit aktiviertem API-Zugriff

---

Schritt 1 — Die requests-Bibliothek installieren

pip install requests

---

Schritt 2 — Authentifizieren

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.")

Tokens niemals einchecken

Speichern Sie token in einem Secrets-Manager oder einer Umgebungsvariablen — codieren Sie Anmeldeinformationen niemals fest. Siehe Token-Speicherung.

---

Schritt 3 — Ihre aktive Organisation abrufen

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}")

---

Schritt 4 — Ihre Safes auflisten

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'))}")

---

Vollständiges Beispiel

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)

---

Fehlerbehandlung

raise_for_status() löst bei 4xx-/5xx-Antworten eine requests.HTTPError aus. Greifen Sie für Details auf exc.response.status_code und exc.response.text zu:

Code	Bedeutung
401 Unauthorized	Token fehlt, ist abgelaufen oder ungültig. Erneut authentifizieren.
403 Forbidden	Dem Token fehlt der erforderliche Geltungsbereich für diesen Endpunkt.
429 Too Many Requests	Ratenlimit überschritten. Prüfen Sie den retry-after-Header.
500 Internal Server Error	Vorübergehender Serverfehler. Mit Backoff erneut versuchen.

---

Ratenlimit-Bewusstsein

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}")

Siehe Ratenlimits für Backoff-Strategien.

---

Nächste Schritte

• Authentifizierungsablauf — vollständiger Token-Lebenszyklus, PATs und sichere Speicherung
• curl-Schnellstart — derselbe Ablauf über die Befehlszeile
• TypeScript-Schnellstart — derselbe Ablauf mit Node.js
• Ratenlimits — die x-ratelimit-*-Header verstehen