Démarrage rapide Python

Ce guide vous accompagne dans l'authentification à l'API VaultPAM et la réalisation de votre première requête avec Python.

Prérequis :

• Python 3.8 ou ultérieur
• Bibliothèque requests : pip install requests
• Un compte VaultPAM avec l'accès API activé

---

Étape 1 — Installer la bibliothèque requests

pip install requests

---

Étape 2 — S'authentifier

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

Ne validez jamais les jetons dans le code

Stockez le token dans un gestionnaire de secrets ou une variable d'environnement — ne codez jamais les identifiants en dur. Consultez Stockage des jetons.

---

Étape 3 — Obtenir votre organisation active

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

---

Étape 4 — Lister vos coffres-forts

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

---

Exemple complet

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)

---

Gestion des erreurs

raise_for_status() lève une exception requests.HTTPError sur les réponses 4xx/5xx. Accédez à exc.response.status_code et exc.response.text pour obtenir les détails :

Code	Signification
401 Unauthorized	Le jeton est manquant, expiré ou invalide. Authentifiez-vous à nouveau.
403 Forbidden	Le jeton ne dispose pas de la portée requise pour ce point de terminaison.
429 Too Many Requests	Limite de débit dépassée. Vérifiez l'en-tête retry-after.
500 Internal Server Error	Erreur serveur transitoire. Réessayez avec un délai progressif.

---

Prise en compte des limites de débit

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

Consultez Limites de débit pour les stratégies de délai progressif.

---

Étapes suivantes

• Flux d'authentification — cycle de vie complet des jetons, PAT et stockage sécurisé
• Démarrage rapide curl — le même flux en ligne de commande
• Démarrage rapide TypeScript — le même flux avec Node.js
• Limites de débit — comprendre les en-têtes x-ratelimit-*