Password Pusher API v2

Authentifizierung

Authentifizieren Sie Anfragen mit einem Bearer-Token im Authorization-Header.

Erstellen Sie ein API-Token in Ihren Kontoeinstellungen unter /users/token.

Authorization: Bearer YOUR_API_TOKEN

• Öffentliche Endpunkte: GET /api/v2/version, GET /api/v2/pushes/:url_token, GET /api/v2/pushes/:url_token/preview
• Authentifizierte Endpunkte: GET /api/v2/pushes/:url_token/audit, GET /api/v2/pushes/active, GET /api/v2/pushes/expired
• Einstellung für anonymen Zugriff: Wenn anonyme Push-Benachrichtigungen deaktiviert sind, ist eine Authentifizierung an den API-Endpunkten erforderlich.

Basis-URL

Alle Endpunkte beziehen sich auf Ihren Installationshost:

https://pwpusher.it.hm.edu/api/v2

Versionsendpunkt

GET /api/v2/version

Gibt Details zur API- und Anwendungsversion zurück.

cURL-Beispiel:

curl -X GET https://pwpusher.it.hm.edu/api/v2/version

{
  "application_version": "2.4.3",
  "api_version": "2.0",
  "edition": "oss"
}

POST /api/v2/pushes

Erstelle einen neuen Push.

Format des Nachrichtentextes: { "push": { ... } }

{
  "push": {
    "payload": "my-secret",
    "expire_after_days": 1,
    "expire_after_views": 5,
    "passphrase": "optional-passphrase",
    "deletable_by_viewer": true,
    "retrieval_step": true
  }
}

cURL-Beispiel (JSON-Body):

curl -X POST https://pwpusher.it.hm.edu/api/v2/pushes \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "push": {
      "payload": "my-secret",
      "expire_after_days": 1,
      "expire_after_views": 5
    }
  }'

GET /api/v2/pushes/:url_token

Eine Push-Payload kann anhand des Tokens abgerufen werden. Dies zählt als Ansicht und kann dazu führen, dass die Push-Payload abläuft, sobald die Grenzwerte erreicht sind.

Abfrageparameter: passphrase (optional, erforderlich, wenn die Push-Benachrichtigung passwortgeschützt ist)

cURL-Beispiel:

curl -X GET https://pwpusher.it.hm.edu/api/v2/pushes/YOUR_URL_TOKEN

GET /api/v2/pushes/:url_token/preview

Gibt die vollständig qualifizierte geheime URL für einen Push zurück, ohne die Nutzdaten abzurufen.

cURL-Beispiel:

curl -X GET https://pwpusher.it.hm.edu/api/v2/pushes/YOUR_URL_TOKEN/preview

GET /api/v2/pushes/:url_token/audit

Gibt Audit-Log-Einträge für einen Push zurück. Authentifizierung und Besitznachweis sind erforderlich.

Abfrageparameter: page (optional, ganze Zahl, Standardwert 1, gültiger Bereich 1 bis 200)

cURL-Beispiel:

curl -X GET "https://pwpusher.it.hm.edu/api/v2/pushes/YOUR_URL_TOKEN/audit?page=1" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

DELETE /api/v2/pushes/:url_token

Push-Benachrichtigungen können sofort ablaufen. Dies ist für Eigentümer (nach Authentifizierung) oder für Empfänger zulässig, wenn die Push-Benachrichtigung mit aktivierter Option „Vom Betrachter löschbar“ erstellt wurde.

cURL-Beispiel:

curl -X DELETE https://pwpusher.it.hm.edu/api/v2/pushes/YOUR_URL_TOKEN \
  -H "Authorization: Bearer YOUR_API_TOKEN"

GET /api/v2/pushes/active

Liste der aktiven Push-Benachrichtigungen für den authentifizierten Benutzer auf.

Abfrageparameter: page (optional, ganze Zahl, Standardwert 1, gültiger Bereich 1 bis 200)

cURL-Beispiel:

curl -X GET "https://pwpusher.it.hm.edu/api/v2/pushes/active?page=1" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

GET /api/v2/pushes/expired

Liste der abgelaufenen Push-Benachrichtigungen für den authentifizierten Benutzer auf.

Abfrageparameter: page (optional, ganze Zahl, Standardwert 1, gültiger Bereich 1 bis 200)

cURL-Beispiel:

curl -X GET "https://pwpusher.it.hm.edu/api/v2/pushes/expired?page=1" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

HTTP-Statuscodes

• 200 - Anfrage erfolgreich
• 201 - Push erstellt
• 400 - Ungültige Anfrageparameter
• 401 - Authentifizierung erforderlich oder ungültiges Token
• 403 - Für den aktuellen Benutzer verboten
• 404 - Ressource nicht gefunden
• 422 - Validierungsfehler