GetMeNotified Push API

Schnelleinstieg

Für einen ersten Test werden nur die Base URL, ein gültiger API-Key und ein JSON-Body mit title und message benötigt.

1. Überblick

GetMeNotified ist eine API-basierte Push-Benachrichtigungsplattform. Kundenanwendungen senden Ereignisse an die API. Die API speichert den Request, erstellt je Zielgerät eine Zustellung und sendet die Push-Benachrichtigung über Firebase Cloud Messaging.

Die aktuelle Version unterstützt mehrere aktive Geräte pro Kunde. Welcher Kunde verwendet wird, ergibt sich aus dem verwendeten API-Key. Ohne Zielangabe wird die Benachrichtigung an alle aktiven Geräte gesendet, die diesem Kunden zugeordnet sind. Optional kann der Request über target auf ein einzelnes Kundengerät oder eine Plattform eingeschränkt werden.

2. Base URL

https://api.getmenotified.com/v1

3. Authentifizierung

Jeder Request benötigt einen API-Key im HTTP-Header Authorization.

Authorization: Bearer YOUR_API_KEY

4. Push senden

Request Header

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Accept: application/json

Minimaler Request

{
  "title": "Neue Meldung",
  "message": "Dies ist eine Testnachricht."
}

Erweiterter Request

{
  "title": "Neue Bestellung",
  "message": "Bestellung 12345 wurde bezahlt.",
  "external_id": "order-12345",
  "data": {
    "source": "shop-api",
    "type": "sale",
    "group": "shop",
    "category": "order",
    "amount": "123.45",
    "currency": "EUR",
    "success": "true",
    "status": "ok"
  }
}

Optionale Zielauswahl

Wird kein target angegeben, bleibt das bisherige Verhalten unverändert: Die Benachrichtigung wird an alle aktiven Geräte des API-Key-Kunden gesendet.

Explizit an alle aktiven Geräte

{
  "title": "Systemmeldung",
  "message": "Nachricht an alle aktiven Geräte.",
  "target": {
    "type": "all"
  }
}

An ein einzelnes Kundengerät

{
  "title": "Gerätemeldung",
  "message": "Nachricht nur an ein bestimmtes Kundengerät.",
  "target": {
    "type": "customer_device_id",
    "id": 2
  }
}

An eine Plattform

{
  "title": "Android-Meldung",
  "message": "Nachricht nur an aktive Android-Geräte.",
  "target": {
    "type": "platform",
    "platform": "android"
  }
}

5. Felder für POST /notifications

Felder für target

6. Empfohlene data-Felder

Für spätere Auswertungen, lokale App-Statistiken und mögliche Reports sollten Ereignisse möglichst konsistent mit standardisierten Datenfeldern gesendet werden.

7. Erfolgsantwort

Bei erfolgreicher Verarbeitung liefert die API ok: true und den Status sent.

{
  "ok": true,
  "status": "sent",
  "target": {
    "type": "all"
  },
  "request": {
    "id": 85,
    "request_uid": "req_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "external_id": "docs-test-001",
    "status": "sent",
    "delivery_count": 1,
    "success_count": 1,
    "failure_count": 0,
    "accepted_at": "2026-06-07 12:00:00",
    "processed_at": "2026-06-07 12:00:00"
  },
  "deliveries": [
    {
      "id": 83,
      "request_id": 85,
      "device_token_id": 2,
      "target_platform": "android",
      "status": "sent",
      "fcm_message_id": "projects/getmenotified-.../messages/...",
      "sent_at": "2026-06-07 12:00:00"
    }
  ],
  "delivery": {
    "id": 83,
    "request_id": 85,
    "device_token_id": 2,
    "target_platform": "android",
    "status": "sent",
    "fcm_message_id": "projects/getmenotified-.../messages/...",
    "sent_at": "2026-06-07 12:00:00"
  }
}

Hinweis: deliveries enthält die Zustellungen pro Zielgerät. Das einzelne delivery-Objekt bleibt aus Kompatibilitätsgründen zusätzlich erhalten und entspricht der ersten Zustellung.

8. Benachrichtigungshistorie

Die History-Endpunkte sind per Bearer API-Key geschützt und liefern nur Einträge des Kunden, zu dem der verwendete API-Key gehört.

History-Liste

GET https://api.getmenotified.com/v1/notifications/history?limit=20&offset=0
Authorization: Bearer YOUR_API_KEY

Detailansicht

GET https://api.getmenotified.com/v1/notifications/req_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Authorization: Bearer YOUR_API_KEY

9. Fehlerantworten

Fehlerantworten haben grundsätzlich diese Struktur:

{
  "ok": false,
  "error": "error_code",
  "message": "Readable error message."
}

10. Beispiel: PowerShell

$apiKey = "YOUR_API_KEY"

$headers = @{
    Authorization = "Bearer $apiKey"
    Accept = "application/json"
}

$body = @{
    title = "Neue Bestellung"
    message = "Bestellung 12345 wurde bezahlt."
    external_id = "order-12345"
    data = @{
        source = "shop-api"
        type = "sale"
        group = "shop"
        category = "order"
        amount = "123.45"
        currency = "EUR"
        success = "true"
        status = "ok"
    }
} | ConvertTo-Json -Depth 10 -Compress

Invoke-RestMethod `
    -Uri "https://api.getmenotified.com/v1/notifications" `
    -Method Post `
    -Headers $headers `
    -ContentType "application/json; charset=utf-8" `
    -Body $body

11. Beispiel: curl

curl -X POST "https://api.getmenotified.com/v1/notifications" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "title": "Neue Bestellung",
    "message": "Bestellung 12345 wurde bezahlt.",
    "external_id": "order-12345",
    "data": {
      "source": "shop-api",
      "type": "sale",
      "group": "shop",
      "category": "order",
      "amount": "123.45",
      "currency": "EUR",
      "success": "true",
      "status": "ok"
    }
  }'

12. Limits und Rate-Limiting

Rate-Limit-Antwort

{
  "ok": false,
  "error": "rate_limit_exceeded",
  "message": "Rate limit exceeded. Please try again later.",
  "rate_limit": {
    "limit": 30,
    "window_seconds": 60,
    "retry_after_seconds": 1
  }
}

13. Sicherheitshinweise

• API-Keys niemals öffentlich teilen.
• API-Keys nicht in Apps, Webseiten oder öffentlichen Repositories hardcoden.
• Keine Passwörter, Tokens oder vertraulichen Zugangsdaten im Feld data senden.
• Für Tests immer Platzhalter wie YOUR_API_KEY verwenden.

14. Aktuelle Einschränkungen und Ausblick

• Ohne target werden Benachrichtigungen an alle aktiven Geräte des API-Key-Kunden gesendet.
• Die Zielauswahl unterstützt aktuell all, customer_device_id und platform.
• Gruppen, Tags oder frei definierte Geräteklassen sind noch nicht Bestandteil des öffentlichen Endpoints.
• Das Kundenportal ist für Beta-/Testkunden aktiv und wird weiter ausgebaut.
• Windows-Agent/Dienst und iOS-Unterstützung sind spätere Roadmap-Punkte.