REST Nur für Bildungszwecke

HofmannAPI

Eine REST-API für strukturierte und individuelle Daten.

API-Key Authentifizierung

Für POST, PUT und DELETE-Anfragen ist ein API-Key erforderlich. Nutzung im Header X-API-KEY oder als Query-Parameter ?api_key=DEIN_API_KEY.
Die Keys unterscheiden sich je nach Ressourcentyp (z. B. books, cars, weather, movies, games, sport-teams).

Bücher

  • GET /api/books Liste aller Bücher abrufen
  • GET /api/books/{id} Details eines Buches anzeigen
  • POST /api/books Neues Buch anlegen (API-Key erforderlich)
  • PUT /api/books/{id} Buch aktualisieren (API-Key erforderlich)
  • DELETE /api/books/{id} Buch löschen (API-Key erforderlich)

Autos

  • GET /api/cars Liste aller Autos abrufen
  • GET /api/cars/{id} Details eines Autos anzeigen
  • POST /api/cars Neues Auto anlegen (API-Key erforderlich)
  • PUT /api/cars/{id} Auto aktualisieren (API-Key erforderlich)
  • DELETE /api/cars/{id} Auto löschen (API-Key erforderlich)

Wetter

  • GET /api/weather Alle Wetterdaten abrufen
  • GET /api/weather/{id} Wettereintrag per ID anzeigen
  • POST /api/weather Neuen Wettereintrag anlegen (API-Key erforderlich)
  • PUT /api/weather/{id} Wetterdaten aktualisieren (API-Key erforderlich)
  • DELETE /api/weather/{id} Wetterdaten löschen (API-Key erforderlich)

Filme

  • GET /api/movies Liste aller Filme abrufen
  • GET /api/movies/{id} Details eines Films anzeigen
  • POST /api/movies Neuen Film anlegen (API-Key erforderlich)
  • PUT /api/movies/{id} Film aktualisieren (API-Key erforderlich)
  • DELETE /api/movies/{id} Film löschen (API-Key erforderlich)

Spiele

  • GET /api/games Liste aller Spiele abrufen
  • GET /api/games/{id} Details eines Spiels anzeigen
  • POST /api/games Neues Spiel anlegen (API-Key erforderlich)
  • PUT /api/games/{id} Spiel aktualisieren (API-Key erforderlich)
  • DELETE /api/games/{id} Spiel löschen (API-Key erforderlich)

Sportteams

  • GET /api/sport-teams Liste aller Sportteams abrufen
  • GET /api/sport-teams/{id} Details eines Sportteams anzeigen
  • POST /api/sport-teams Neues Sportteam anlegen (API-Key erforderlich)
  • PUT /api/sport-teams/{id} Sportteam aktualisieren (API-Key erforderlich)
  • DELETE /api/sport-teams/{id} Sportteam löschen (API-Key erforderlich)

Custom Data

Universeller Datenspeicher für beliebige Zwecke (z. B. Coins, Spielstände, Einstellungen, etc.).
Hinweis: Alle Daten sind mandantengetrennt (API-Key bestimmt den Client) und werden nur für den jeweiligen Client angezeigt.

  • GET /api/data Alle eigenen Einträge abrufen (API-Key erforderlich)
  • GET /api/data/{id} Einzelnen Eintrag per ID anzeigen (API-Key erforderlich)
  • GET /api/data/category/{category} Alle Einträge nach Kategorie filtern (API-Key erforderlich)
  • POST /api/data Neuen Eintrag speichern (API-Key + Kategorie erforderlich)
  • PUT /api/data/{id} Eintrag aktualisieren (API-Key erforderlich)
  • DELETE /api/data/{id} Eintrag löschen (API-Key erforderlich)

Der POST-Body muss ein JSON-Objekt enthalten mit mindestens einem category-Feld sowie einem data-Objekt:

{
  "category": "coins",
  "data": {
    "gold": 100,
    "silver": 250
  }
}

© Thomas Hofmann

Hofmann API