Authentifizierung

Der Zugriff auf die Partner API erfordert eine Authentifizierung mit geheimen API-Schlüsseln. Erstellen und verwalten Sie Ihre Schlüssel über die Partner Console.

API-Schlüssel dienen als Ihre Anmeldedaten für den Zugriff auf Partnerressourcen. Jeder Schlüssel hat eingeschränkten Zugriff auf bestimmte Organisationsdaten und kann bei Bedarf sofort deaktiviert werden.

Gehen Sie sorgfältig mit Ihren API-Schlüsseln um – sie gewähren vollen Zugriff auf Ihr Konto! Legen Sie diese Schlüssel niemals in öffentlichen Repositorys, clientseitigen Anwendungen oder an anderen Stellen offen, an denen sie kompromittiert werden könnten.

Authentifizieren Sie Anfragen per HTTP Basic Auth, indem Sie Ihren API-Schlüssel als Benutzernamen übergeben. Lassen Sie das Passwort leer.

Die API akzeptiert ausschließlich sichere HTTPS-Verbindungen. Einfache HTTP-Anfragen werden abgelehnt, ebenso alle Anfragen ohne gültige Anmeldedaten.

Beispielanfrage

curl https://partner-api.performancehub.co/partner/v1/organisations \
  -u sk_live_YOUR_PARTNER_SECRET_KEY:
# The colon prevents curl from asking for a password.

Geheimen Schlüssel überprüfen

curl https://partner-api.performancehub.co/partner/v1/auth/ping \
  -u sk_live_YOUR_PARTNER_SECRET_KEY:
# Returns { "message": "You are successfully authorised as <PartnerName>" }