API-Dokumentation

Leitet zu Google weiter (HTTP 302). Nach der Rückkehr legt Auth.js das Sitzungs-Cookie an. Gedacht für Browser, nicht für Skripte.

Antworten

• 302Weiterleitung zu Google.

Auth.js-Standardroute. Liefert die Sitzung der Cookie-Inhaberin oder des Inhabers, ohne Sitzung null. Die Anmelderoute ist je IP auf 20 Anfragen pro Minute begrenzt.

Antworten

• 200Sitzung oder null.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  Variante 2	object	nein
  user	object	nein
  user.id	string	nein
  user.email	string	nein
  user.name	string | null	nein
  user.role	"USER" | "PARTNER" | "ADMIN" | "SUPER_ADMIN"	nein
  expires	string (date-time)	nein

• 429Zu viele Anfragen in kurzer Zeit.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  error	string	ja
  retryAfter	integer	nein	Sekunden bis zum nächsten erlaubten Versuch (nur bei IP-Limits der Anmeldung).

Auth.js-Standardroute. Das Token wird für POST /api/auth/callback/credentials und POST /api/auth/signout gebraucht und muss zusammen mit dem gesetzten Cookie zurückgesendet werden.

Antworten

• 200Token.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  csrfToken	string	ja

• 429Zu viele Anfragen in kurzer Zeit.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  error	string	ja
  retryAfter	integer	nein	Sekunden bis zum nächsten erlaubten Versuch (nur bei IP-Limits der Anmeldung).

Auth.js-Standardroute. Bei Erfolg setzt die Antwort das Sitzungs-Cookie. Die Anmeldeversuche sind je IP begrenzt. Ist ein zweiter Faktor aktiv, muss zusätzlich code mitgeschickt werden. Das Formular unter /login ist der unterstützte Weg; diese Route ist nicht für dauerhafte Integrationen gedacht.

application/x-www-form-urlencoded· erforderlich

Antworten

• 302Weiterleitung; bei Erfolg mit gesetztem Sitzungs-Cookie, sonst zurück zur Anmeldung mit Fehlerhinweis.
• 429Zu viele Anfragen in kurzer Zeit.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  error	string	ja
  retryAfter	integer	nein	Sekunden bis zum nächsten erlaubten Versuch (nur bei IP-Limits der Anmeldung).

Auth.js-Standardroute. Beendet die Sitzung und löscht das Cookie.

application/x-www-form-urlencoded· erforderlich

Antworten

• 302Weiterleitung nach dem Abmelden.
• 429Zu viele Anfragen in kurzer Zeit.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  error	string	ja
  retryAfter	integer	nein	Sekunden bis zum nächsten erlaubten Versuch (nur bei IP-Limits der Anmeldung).

Für Überwachung von außen. Prüft Datenbank und Zwischenspeicher mit je drei Sekunden Zeitlimit. Öffentlich und ohne Details — keine Versionen, Hosts oder Fehlermeldungen. Je IP höchstens 60 Anfragen pro Minute.

Antworten

• 200Datenbank erreichbar. status ist ok oder eingeschraenkt (Zwischenspeicher gestört, App läuft weiter).

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  status	"ok" | "eingeschraenkt"	ja
  datenbank	"ok" | "gestoert"	ja
  cache	"ok" | "gestoert"	ja

• 429Zu viele Anfragen.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  status	"zu-viele-anfragen"	nein

• 503Datenbank nicht erreichbar (status: gestoert).

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  status	"gestoert"	nein
  datenbank	"gestoert"	nein
  cache	"ok" | "gestoert"	nein

Empfänger für report-uri der Browser. Öffentlich und ohne Anmeldung. Je IP (IPv6 je /64) höchstens 30 Berichte pro Stunde; Body höchstens 20 KB. Protokolliert wird nur das Nötigste (verletzte Richtlinie, Ziel-Origin, Seitenpfad ohne Query) — keine IP, keine ganzen Adressen. Die Antwort ist immer 204, auch bei Limit oder ungültigem Inhalt.

application/csp-reportapplication/reports+jsonapplication/json· erforderlich

Antworten

• 204Entgegengenommen (oder verworfen — das lässt sich von außen nicht unterscheiden).

Die Fehlerseiten der App melden hierher. Nur von der eigenen Seite (Sec-Fetch-Site: same-origin); andere Absender werden still verworfen. Je IP höchstens 20 Berichte pro Stunde; Body höchstens 8 KB. Es werden Nachricht, Pfad, Digest, App-Version und die Personengruppe (Betreiber / angemeldet / nicht angemeldet, aus dem Sitzungs-Cookie) protokolliert — keine Nutzerkennung, keine IP. Die Antwort ist immer 204.

application/json· erforderlich

Antworten

• 204Entgegengenommen oder verworfen.

Anmeldung ist optional: Mit Sitzung werden Nutzerkennung, aktiver Haushalt und Tarif serverseitig ergänzt — Werte dazu im Body werden ignoriert. Ohne Sitzung ist die Meldung anonym. Begrenzt auf 30 Meldungen je IP (IPv6 je /64) und Stunde; Body höchstens 16 KB.

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

application/json· erforderlich

Antworten

• 201Gespeichert.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  success	true	ja
  id	string	ja

• 400Kein gültiges JSON.

  application/json

• 403Die Anfrage kam nicht von StockPilot selbst (Schutz vor fremd ausgelösten Anfragen). Wird bei ändernden Aufrufen aus dem Browser mit fremdem Origin ausgelöst.

  application/json

• 413Die Meldung ist zu lang.

  application/json

• 422Ungültige Eingabe (Text leer oder zu lang).

  application/json

• 429Zu viele Meldungen in kurzer Zeit.

  application/json

Liefert ein in der Datenbank gespeichertes Bild als Datei. Profilbilder (avatar) nur mit Sitzung und nicht zwischen Personen mit Blockade; Titelbilder (cover) nur für Mitglieder des Haushalts. Der Parameter v muss zum aktuellen Bild passen — die Adresse lässt sich nicht aus einer Kennung allein bilden. Cache: private, no-cache mit ETag (Rückfrage mit If-None-Match ergibt 304).

Antworten

• 200Das Bild.

  image/jpegimage/pngimage/webpimage/gif

• 304Unverändert (ETag passt).
• 401Keine gültige Sitzung.

  application/jsontext/plain

• 404Kein Bild, falsche Version, kein Zugriff (Text Not Found).

  text/plain

Liefert das gespeicherte Bild eines Kassenbons — nur an die Eigentümerin oder den Eigentümer und an berechtigte Betreiber. Antwort mit Cache-Control: private, no-store.

Antworten

• 200Das Bild.

  image/jpegimage/pngimage/webp

• 401Keine gültige Sitzung.

  application/jsontext/plain

• 403Kein Zugriff (keine Teilnahme, Blockade oder Rolle).

  application/json

• 404Nicht gefunden — oder für die angemeldete Person nicht sichtbar.

  application/json

Findet die Ecken des Bons im Foto, damit die App es zuschneiden kann. Das Bild wird nur zur Berechnung gelesen und nicht gespeichert. Tageslimit: 100 Erkennungen je Konto. Datei höchstens 10 MB.

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

multipart/form-data· erforderlich

Antworten

• 200Ecken im Uhrzeigersinn ab links oben, in Pixeln des (ausgerichteten) Bilds. Wird kein Papier gefunden, ist es das ganze Bild. bonAnzahl ab 2: Mehrere Bons liegen nebeneinander (höchstens 4), die Ecken umfassen dann nur den breitesten. Bons untereinander zählen hier nicht mit; sie trennt erst das Auslesen, wenn bei jedem die Summe aufgeht.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  corners	object[]	ja
  corners[].x	number	ja
  corners[].y	number	ja
  imageWidth	integer	ja
  imageHeight	integer	ja
  bonAnzahl	integer (≥ 1, ≤ 4)	ja

• 400Keine Datei.

  application/json

• 401Keine gültige Sitzung.

  application/jsontext/plain

• 403Die Anfrage kam nicht von StockPilot selbst (Schutz vor fremd ausgelösten Anfragen). Wird bei ändernden Aufrufen aus dem Browser mit fremdem Origin ausgelöst.

  application/json

• 413Datei zu groß.

  application/json

• 429Das Tageslimit für diese Art von Inhalt ist erreicht. Morgen geht es weiter.

  application/json

• 500Erkennung fehlgeschlagen.

  application/json

Speichert das Bild neu kodiert und liefert den Dateinamen, der beim Erstellen oder Bearbeiten eines Beitrags oder Kommentars als imageFilename mitgeschickt wird. Voraussetzung: bestätigte E-Mail-Adresse und ein angelegter Haushalt. Tageslimit: 30 Bilder je Konto.

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

multipart/form-data· erforderlich

Antworten

• 200Gespeichert.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  filename	string	ja
  url	string	ja

• 400Datei fehlt, falscher Typ (nur JPEG, PNG, WebP) oder Pflichtfeld fehlt.

  application/json

• 401Keine gültige Sitzung.

  application/jsontext/plain

• 403E-Mail nicht bestätigt oder kein Haushalt angelegt.

  application/json

• 413Datei oder Anfrage zu groß.

  application/json

• 429Das Tageslimit für diese Art von Inhalt ist erreicht. Morgen geht es weiter.

  application/json

Höchstens 5 Bilder je Angebot. Neue Bilder können zur Prüfung zurückgehalten werden (zurPruefung). Tageslimit: 60 Bilder je Konto.

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

multipart/form-data· erforderlich

Antworten

• 200Gespeichert.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  id	string	ja
  url	string	ja
  zurPruefung	boolean	ja

• 400Datei fehlt, falscher Typ (nur JPEG, PNG, WebP) oder Pflichtfeld fehlt.

  application/json

• 401Keine gültige Sitzung.

  application/jsontext/plain

• 403Die Anfrage kam nicht von StockPilot selbst (Schutz vor fremd ausgelösten Anfragen). Wird bei ändernden Aufrufen aus dem Browser mit fremdem Origin ausgelöst.

  application/json

• 404Angebot nicht gefunden oder nicht das eigene.

  application/json

• 413Datei oder Anfrage zu groß.

  application/json

• 429Das Tageslimit für diese Art von Inhalt ist erreicht. Morgen geht es weiter.

  application/json

• 500Hochladen fehlgeschlagen.

  application/json

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

Antworten

• 200Entfernt.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  ok	true	ja

• 400imageId fehlt.

  application/json

• 401Keine gültige Sitzung.

  application/jsontext/plain

• 403Die Anfrage kam nicht von StockPilot selbst (Schutz vor fremd ausgelösten Anfragen). Wird bei ändernden Aufrufen aus dem Browser mit fremdem Origin ausgelöst.

  application/json

• 404Bild nicht gefunden oder nicht das eigene.

  application/json

• 500Entfernen fehlgeschlagen.

  application/json

Nutzerinnen und Nutzer schlagen Korrekturen vor, Betreiber entscheiden darüber. Nicht verwendete Bilder werden nach sieben Tagen gelöscht. Tageslimit: 30 Bilder je Konto.

Voraussetzung: bestätigte E-Mail-Adresse (sonst 403 „E-Mail nicht bestätigt“).

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

multipart/form-data· erforderlich

Antworten

• 200Gespeichert.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  url	string (uri)	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 400Datei fehlt, falscher Typ (nur JPEG, PNG, WebP) oder Pflichtfeld fehlt.

  application/json

• 403E-Mail-Adresse nicht bestätigt ({ "error": "E-Mail nicht bestätigt" }).

  application/json

• 413Datei oder Anfrage zu groß.

  application/json

• 429Das Tageslimit für diese Art von Inhalt ist erreicht. Morgen geht es weiter.

  application/json

recipeType bestimmt, wohin das Foto gehört: user = eigenes Rezept (Standard), community-user = freigegebenes Rezept einer anderen Person, system = Systemrezept. Höchstens 3 Fotos je Rezept. Tageslimit: 30 Fotos je Konto.

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

multipart/form-data· erforderlich

Antworten

• 200Gespeichert.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  id	string	ja
  url	string	ja

• 400Datei oder recipeId fehlt, ungültiger recipeType, falscher Dateityp oder schon 3 Fotos am Rezept.

  application/json

• 401Keine gültige Sitzung.

  application/jsontext/plain

• 403Rezept nicht für die Community freigegeben.

  application/json

• 404Rezept nicht gefunden.

  application/json

• 413Datei oder Anfrage zu groß.

  application/json

• 429Das Tageslimit für diese Art von Inhalt ist erreicht. Morgen geht es weiter.

  application/json

Alle Artikel, die nicht verbraucht sind. UTF-8 mit Byte-Order-Mark, Zeilenende CRLF, jede Zelle in Anführungszeichen; Zellen, die wie Formeln beginnen, werden entschärft. Spalten: Name, Marke, Kategorie, Menge, Einheit, Lagerort, MHD (Tage), MHD-Datum. Antwort mit Cache-Control: private, no-store.

Antworten

• 200CSV-Datei als Download (stockpilot-vorrat-JJJJ-MM-TT.csv).

  text/csv

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 400Kein aktiver Haushalt (Text Kein aktiver Haushalt).

  text/plain

• 500Export fehlgeschlagen (Text Fehler beim Export).

  text/plain

Offener Ereignisstrom für die Einkaufsliste eines Haushalts. Das erste Ereignis connected trägt { "householdId": … }; danach kommt bei jeder Änderung ein Ereignis update mit einem Zeitstempel als Daten. Alle 25 Sekunden folgt ein Herzschlag. Höchstens 8 gleichzeitige Ströme je Person — der älteste wird geschlossen. Die Mitgliedschaft wird bei jedem Herzschlag erneut geprüft. Steht der Ereigniskanal nicht zur Verfügung, kommen keine Ereignisse; Clients sollten dann selbst nachladen. Fehlertexte sind reiner Text.

Antworten

• 200Ereignisstrom.

  text/event-stream

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 400householdId fehlt (Text Missing householdId).

  text/plain

• 403Kein Mitglied des Haushalts (Text Forbidden).

  text/plain

• 503Datenbank nicht erreichbar (Text Service unavailable).

  text/plain

Antworten

• 200Liste.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  conversations	Unterhaltung[]	ja
  conversations[].id	string | null	nein	Leer, solange es mit dieser Person noch keine Unterhaltung gibt.
  conversations[].otherUserId	string	ja
  conversations[].otherUserName	string	ja
  conversations[].otherUserAvatarUrl	string | null	nein
  conversations[].otherLastSeenAt	string | null (date-time)	nein
  conversations[].listingId	string | null	nein
  conversations[].listingTitle	string | null	nein
  conversations[].isFriend	boolean	nein
  conversations[].lastMessage	string | null	nein
  conversations[].lastMessageKind	"photo" | "gif" | "location" | "voice" | null	nein
  conversations[].lastMessageAt	string | null (date-time)	nein
  conversations[].lastMessageIsOwn	boolean	nein
  conversations[].lastMessageReadAt	string | null (date-time)	nein
  conversations[].unreadCount	integer (≥ 0)	ja
  conversations[].blockedByMe	boolean	ja
  conversations[].blockedMe	boolean	ja
  incomingRequests	NachbarAnfrage[]	ja
  incomingRequests[].id	string	ja
  incomingRequests[].requesterId	string	ja
  incomingRequests[].requesterName	string	ja
  incomingRequests[].requesterAvatarUrl	string | null	nein
  incomingRequests[].message	string	ja
  incomingRequests[].createdAt	string (date-time)	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.

Ohne Sitzung (und bei Fehlern) antwortet die Route mit { "count": 0 } statt mit einer Weiterleitung.

Antworten

• 200Anzahl.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  count	integer (≥ 0)	ja

Seitenweise, immer aufsteigend nach Zeit. Ohne Parameter die jüngsten 50. vor lädt die 50 davor, nach neuere ab dieser Nachricht (mit kleiner Überlappung), ids frischt einzelne Nachrichten auf (höchstens 100; kombinierbar mit nach). vor ist nicht mit nach/ids kombinierbar. Das Laden markiert eingehende Nachrichten als gelesen (Sprachnachrichten erst nach dem Anhören).

Antworten

• 200Seite.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  messages	ChatNachricht[]	ja	Aufsteigend nach Zeit.
  messages[].id	string	ja
  messages[].content	string	ja	Text, höchstens 500 Zeichen. Bei Foto-Nachrichten die Bildunterschrift (bis 2000 Zeichen), bei Sprach-, Standort- und Sticker-Nachrichten leer.
  messages[].createdAt	string (date-time)	ja
  messages[].readAt	string | null (date-time)	nein	Wann die andere Seite die Nachricht gelesen hat.
  messages[].isOwn	boolean	ja	Stammt die Nachricht von der angemeldeten Person?
  messages[].senderId	string	ja
  messages[].senderName	string	ja
  messages[].imageUrl	string | null	nein	Adresse eines Chat-Fotos (/uploads/messages/…, nur für Teilnehmende abrufbar).
  messages[].audioUrl	string | null	nein	Adresse einer Sprachnachricht (/uploads/messages/…).
  messages[].durationSeconds	integer | null	nein
  messages[].location	null | object	nein	Vom Absender bewusst geteilter Standort einer Standort-Nachricht.
  messages[].location.lat	number	ja
  messages[].location.lng	number	ja
  messages[].gifId	string | null	nein
  messages[].editedAt	string | null (date-time)	nein
  messages[].isDeleted	boolean	ja
  messages[].reactions	object[]	ja
  messages[].reactions[].emoji	string	ja
  messages[].reactions[].userId	string	ja
  hasMore	boolean	ja	Gibt es jenseits dieser Seite noch Nachrichten?

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 400vor mit nach oder ids kombiniert.

  application/json

• 403Keine Teilnahme an der Unterhaltung.

  application/json

• 404Die Bezugsnachricht ist nicht (mehr) sichtbar.

  application/json

Mit clientId ist das Senden wiederholbar: Kam die Antwort nicht an und der Client sendet erneut, liefert der zweite Aufruf dieselbe Nachricht statt einer zweiten. Läuft der erste Aufruf noch, antwortet die Route 409. Tageslimit: 1000 Nachrichten je Konto (gilt gemeinsam für Text, Sticker und Standorte).

Voraussetzung: bestätigte E-Mail-Adresse (sonst 403 „E-Mail nicht bestätigt“).

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

application/json· erforderlich

Antworten

• 200Gesendet.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  message	object	ja
  message.id	string	ja
  message.createdAt	string (date-time)	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 400Ungültige Eingabe (Inhalt, Datei, Dauer, Koordinaten) oder Gespräch durch Blockade gesperrt.

  application/json

• 403Keine Teilnahme an der Unterhaltung — oder E-Mail-Adresse nicht bestätigt.

  application/json

• 409Dieselbe clientId wird gerade noch gespeichert.

  application/json

• 429Das Tageslimit für diese Art von Inhalt ist erreicht. Morgen geht es weiter.

  application/json

Nur die eigene Nachricht und nur in den ersten 15 Minuten. Sie bleibt für alle als gelöscht markiert (isDeleted) sichtbar; Text, Bild, Audio, Standort und Sticker werden entfernt. Wiederholtes Löschen ist unschädlich.

Voraussetzung: bestätigte E-Mail-Adresse (sonst 403 „E-Mail nicht bestätigt“).

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

Antworten

• 200Gelöscht.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  message	object	ja
  message.id	string	nein

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 403Keine Teilnahme, Blockade, nicht die eigene Nachricht, 15-Minuten-Fenster abgelaufen oder E-Mail nicht bestätigt.

  application/json

• 404Nicht gefunden — oder für die angemeldete Person nicht sichtbar.

  application/json

Nur eigene Nachrichten, außer Sprach- und Standortnachrichten, und nur in den ersten 15 Minuten nach dem Senden (danach 403).

Voraussetzung: bestätigte E-Mail-Adresse (sonst 403 „E-Mail nicht bestätigt“).

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

application/json· erforderlich

Antworten

• 200Bearbeitet.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  message	object	ja
  message.id	string	nein
  message.editedAt	string (date-time)	nein

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 400Ungültiger Inhalt, nicht bearbeitbar (Sprache, Standort) oder schon gelöscht.

  application/json

• 403Keine Teilnahme, Blockade, nicht die eigene Nachricht, 15-Minuten-Fenster abgelaufen oder E-Mail nicht bestätigt.

  application/json

• 404Nicht gefunden — oder für die angemeldete Person nicht sichtbar.

  application/json

Setzt die Lesebestätigung einer erhaltenen Sprachnachricht (idempotent).

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

Antworten

• 200Gemeldet.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  message	object	ja
  message.messageId	string	nein

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 400Keine Sprachnachricht.

  application/json

• 403Keine Teilnahme oder Blockade.

  application/json

• 404Nicht gefunden — oder für die angemeldete Person nicht sichtbar.

  application/json

Setzt oder ersetzt die eigene Reaktion (eine je Person und Nachricht).

Voraussetzung: bestätigte E-Mail-Adresse (sonst 403 „E-Mail nicht bestätigt“).

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

application/json· erforderlich

Antworten

• 200Gesetzt.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  reaction	object	ja
  reaction.messageId	string	nein
  reaction.emoji	string	nein

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 400Ungültiges Emoji oder Nachricht gelöscht.

  application/json

• 403Keine Teilnahme, Blockade oder E-Mail nicht bestätigt.

  application/json

• 404Nicht gefunden — oder für die angemeldete Person nicht sichtbar.

  application/json

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

Antworten

• 200Entfernt (auch, wenn keine vorhanden war).

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  reaction	object	ja
  reaction.messageId	string	nein

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 403Keine Teilnahme oder Blockade.

  application/json

• 404Nicht gefunden — oder für die angemeldete Person nicht sichtbar.

  application/json

Aus Sicht der angemeldeten Person. Ob das Gegenüber blockiert hat, verrät die Antwort nicht eigens — nur, ob die Unterhaltung gesperrt ist.

Antworten

• 200Stand.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  blockedByMe	boolean	ja
  gesperrt	boolean	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 404Keine Teilnahme an der Unterhaltung.

  application/json

Tageslimit gemeinsam mit Textnachrichten (1000 je Konto).

Voraussetzung: bestätigte E-Mail-Adresse (sonst 403 „E-Mail nicht bestätigt“).

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

application/json· erforderlich

Antworten

• 200Gesendet.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  message	object	ja
  message.id	string	ja
  message.createdAt	string (date-time)	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 400Ungültige Eingabe (Inhalt, Datei, Dauer, Koordinaten) oder Gespräch durch Blockade gesperrt.

  application/json

• 403Keine Teilnahme an der Unterhaltung — oder E-Mail-Adresse nicht bestätigt.

  application/json

• 429Das Tageslimit für diese Art von Inhalt ist erreicht. Morgen geht es weiter.

  application/json

Teilt einen von der Person gewählten Punkt als Nachricht — das ist eine bewusste Einzelaktion, kein Live-Standort. Tageslimit gemeinsam mit Textnachrichten (1000 je Konto).

Voraussetzung: bestätigte E-Mail-Adresse (sonst 403 „E-Mail nicht bestätigt“).

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

application/json· erforderlich

Antworten

• 200Gesendet.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  message	object	ja
  message.id	string	ja
  message.createdAt	string (date-time)	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 400Ungültige Eingabe (Inhalt, Datei, Dauer, Koordinaten) oder Gespräch durch Blockade gesperrt.

  application/json

• 403Keine Teilnahme an der Unterhaltung — oder E-Mail-Adresse nicht bestätigt.

  application/json

• 429Das Tageslimit für diese Art von Inhalt ist erreicht. Morgen geht es weiter.

  application/json

Wer nicht teilnimmt, ändert nichts und bekommt ok: false — kein 403, damit die Antwort nicht verrät, ob es die Unterhaltung gibt.

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

application/json· erforderlich

Antworten

• 200Ergebnis.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  ok	boolean	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 400stumm fehlt oder ist kein Wahrheitswert.

  application/json

• 403Die Anfrage kam nicht von StockPilot selbst (Schutz vor fremd ausgelösten Anfragen). Wird bei ändernden Aufrufen aus dem Browser mit fremdem Origin ausgelöst.

  application/json

Das Foto wird zu WebP umgerechnet und ohne Metadaten gespeichert. Abrufbar nur für Teilnehmende (/uploads/messages/…). Tageslimit: 100 Fotos je Konto.

Voraussetzung: bestätigte E-Mail-Adresse (sonst 403 „E-Mail nicht bestätigt“).

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

multipart/form-data· erforderlich

Antworten

• 200Gesendet.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  message	object	ja
  message.id	string	ja
  message.createdAt	string (date-time)	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 400Ungültige Eingabe (Inhalt, Datei, Dauer, Koordinaten) oder Gespräch durch Blockade gesperrt.

  application/json

• 403Keine Teilnahme an der Unterhaltung — oder E-Mail-Adresse nicht bestätigt.

  application/json

• 413Datei oder Anfrage zu groß.

  application/json

• 429Das Tageslimit für diese Art von Inhalt ist erreicht. Morgen geht es weiter.

  application/json

• 500Speichern fehlgeschlagen.

  application/json

Bei Blockade (in eine der beiden Richtungen) oder ohne Gegenüber sind beide Werte null. distanceBucket ist zusätzlich null, wenn nicht beide Personen in der Nachbarschaft sichtbar sind; die Entfernung kommt als grobe Stufe.

Antworten

• 200Anwesenheit.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  lastSeenAt	string | null (date-time)	ja
  distanceBucket	null | "<1" | "1-3" | "3-10" | ">10"	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 403Keine Teilnahme an der Unterhaltung.

  application/json

Offener Ereignisstrom. Ereignisse: connected ({ conversationId }), message ({ kind, messageId?, readerId? } — nur Kennungen, den Inhalt holt der Client über GET /api/messages/{conversationId}), typing ({ senderId }) und block ({}; danach den Stand über …/block abfragen). Bei Blockade kommt außer block nichts mehr durch. Herzschlag alle 25 Sekunden; höchstens 8 gleichzeitige Ströme je Person. Solange der Strom steht, gilt die Unterhaltung als geöffnet — für neue Nachrichten darin gibt es dann keine Push-Mitteilung. Fehlertexte sind reiner Text.

Antworten

• 200Ereignisstrom.

  text/event-stream

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 403Keine Teilnahme (Text Forbidden).

  text/plain

Sendet das Ereignis typing an die Unterhaltung. Bei Blockade 403.

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

Antworten

• 200Gemeldet.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  ok	true	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 403Keine Teilnahme oder Blockade.

  application/json

Wer nicht teilnimmt, ändert nichts und bekommt ok: false. endgueltig zeigt, dass beide Seiten gelöscht haben und die Unterhaltung entfernt wurde.

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

Antworten

• 200Ergebnis.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  ok	boolean	ja
  endgueltig	boolean	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 403Die Anfrage kam nicht von StockPilot selbst (Schutz vor fremd ausgelösten Anfragen). Wird bei ändernden Aufrufen aus dem Browser mit fremdem Origin ausgelöst.

  application/json

Audio als WebM oder MP4/M4A, höchstens 8 MB und 120 Sekunden. Abrufbar nur für Teilnehmende. Tageslimit: 100 Sprachnachrichten je Konto.

Voraussetzung: bestätigte E-Mail-Adresse (sonst 403 „E-Mail nicht bestätigt“).

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

multipart/form-data· erforderlich

Antworten

• 200Gesendet.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  message	object	ja
  message.id	string	ja
  message.createdAt	string (date-time)	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 400Ungültige Eingabe (Inhalt, Datei, Dauer, Koordinaten) oder Gespräch durch Blockade gesperrt.

  application/json

• 403Keine Teilnahme an der Unterhaltung — oder E-Mail-Adresse nicht bestätigt.

  application/json

• 413Datei oder Anfrage zu groß.

  application/json

• 429Das Tageslimit für diese Art von Inhalt ist erreicht. Morgen geht es weiter.

  application/json

• 500Speichern fehlgeschlagen.

  application/json

Ist die eigene Sichtbarkeit aus, sind alle Listen leer. Die Heatmap enthält nur aggregierte Zellen mit Mindestanzahl; es gibt keine Einzelmarker und keine genauen Standorte.

Antworten

• 200Übersicht.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  visible	boolean	ja
  neighbors	Nachbar[]	ja
  neighbors[].userId	string	ja
  neighbors[].name	string	ja
  neighbors[].avatarUrl	string | null	nein
  neighbors[].lastSeenAt	string | null (date-time)	nein
  neighbors[].isFriend	boolean	nein
  neighbors[].distanceBucket	"<1" | "1-3" | "3-10" | ">10"	ja	Grobe Entfernung in Kilometern.
  neighbors[].status	"none" | "requested" | "connected"	ja
  neighbors[].conversationId	string | null	nein
  neighbors[].unreadCount	integer (≥ 0)	nein
  incomingRequests	NachbarAnfrage[]	ja
  incomingRequests[].id	string	ja
  incomingRequests[].requesterId	string	ja
  incomingRequests[].requesterName	string	ja
  incomingRequests[].requesterAvatarUrl	string | null	nein
  incomingRequests[].message	string	ja
  incomingRequests[].createdAt	string (date-time)	ja
  heatmap	object	ja
  heatmap.cells	HeatmapZelle[]	ja
  heatmap.cells[].lat	number	ja
  heatmap.cells[].lng	number	ja
  heatmap.cells[].count	integer (≥ 3)	ja
  heatmap.center	null | Koordinaten	ja
  heatmap.center.lat	number (≥ -90, ≤ 90)	ja
  heatmap.center.lng	number (≥ -180, ≤ 180)	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.

Einschalten braucht einen Standort: aus dem Body oder, wenn dort keiner steht, aus der Postleitzahl im Profil. Er wird gerundet gespeichert. Ausschalten löscht den gespeicherten Standort.

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

application/json· erforderlich

Antworten

• 200Umgestellt.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  ok	true	ja
  visible	boolean	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 400Ungültige Eingabe, oder kein Standort verfügbar ({ "error": "no_location" }).

  application/json

• 403Die Anfrage kam nicht von StockPilot selbst (Schutz vor fremd ausgelösten Anfragen). Wird bei ändernden Aufrufen aus dem Browser mit fremdem Origin ausgelöst.

  application/json

• 500Fehler.

  application/json

Wirkt nur bei eingeschalteter Sichtbarkeit; der Standort wird gerundet gespeichert. Höchstens 30 Aufrufe pro Stunde je Konto.

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

application/json· erforderlich

Antworten

• 200Aufgefrischt.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  ok	true	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 400Ungültige Koordinaten.

  application/json

• 403Die Anfrage kam nicht von StockPilot selbst (Schutz vor fremd ausgelösten Anfragen). Wird bei ändernden Aufrufen aus dem Browser mit fremdem Origin ausgelöst.

  application/json

• 429Zu viele Standort-Aktualisierungen.

  application/json

Nur an sichtbare Personen im Umkreis (20 km) und nicht bei Blockade. Je Konto gilt ein Tageslimit für Anfragen (429).

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

application/json· erforderlich

Antworten

• 200Ergebnis.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  status	"sent" | "reverse_exists" | "already_connected"	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 400Ungültige Eingabe, Anfrage an sich selbst oder Blockade.

  application/json

• 403Zu weit entfernt oder nicht in der Nachbarschaft sichtbar.

  application/json

• 429Tageslimit für Anfragen erreicht.

  application/json

Beim Annehmen entsteht eine Unterhaltung, ihre Kennung steht in der Antwort.

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

application/json· erforderlich

Antworten

• 200Beantwortet.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  conversationId	string | null	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 400Ungültige Eingabe.

  application/json

• 403Nicht die Empfängerin oder der Empfänger der Anfrage.

  application/json

• 409Mit dieser Person ist kein Chat möglich (Blockade).

  application/json

Speichert ein Web-Push-Abonnement. Nur bekannte Push-Dienste sind erlaubt. Höchstens 10 Abonnements je Konto — ältere weichen dem neuen. Ein Abonnement, das schon einem anderen Konto gehört, wird nur bei gleichen Schlüsseln übernommen. Body höchstens 8 KB.

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

application/json· erforderlich

Antworten

• 200Gespeichert.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  ok	true	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 400Pflichtfelder fehlen, unbekannter Push-Dienst oder ungültige Schlüssel.

  application/json

• 403Die Anfrage kam nicht von StockPilot selbst (Schutz vor fremd ausgelösten Anfragen). Wird bei ändernden Aufrufen aus dem Browser mit fremdem Origin ausgelöst.

  application/json

• 409Das Abonnement gehört zu einem anderen Konto.

  application/json

• 413Zu groß.

  application/json

• 500Datenbankfehler.

  application/json

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

application/json· erforderlich

Antworten

• 200Entfernt (auch, wenn es kein Abonnement gab).

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  ok	true	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 400endpoint fehlt oder ungültiges JSON.

  application/json

• 403Die Anfrage kam nicht von StockPilot selbst (Schutz vor fremd ausgelösten Anfragen). Wird bei ändernden Aufrufen aus dem Browser mit fremdem Origin ausgelöst.

  application/json

• 500Datenbankfehler.

  application/json

Höchstens 5 Tests pro Stunde und Konto. Ein abgelaufenes Abonnement wird dabei entfernt. Aus der Store-App mit { geraeteToken } im Körper: dann an genau dieses Gerät über FCM.

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

Antworten

• 200Gesendet.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  success	true	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 400Store-App: ungültiges Gerätetoken.

  application/json

• 403Die Anfrage kam nicht von StockPilot selbst (Schutz vor fremd ausgelösten Anfragen). Wird bei ändernden Aufrufen aus dem Browser mit fremdem Origin ausgelöst.

  application/json

• 404Auf dem Gerät sind Mitteilungen noch nicht eingeschaltet.

  application/json

• 429Zu viele Tests.

  application/json

• 502Der Push-Dienst hat abgelehnt; das Abonnement ist möglicherweise abgelaufen.

  application/json

• 503Mitteilungen sind serverseitig nicht eingerichtet.

  application/json

Die Android-App fragt vor dem Einschalten, ob der Versand über Firebase Cloud Messaging eingerichtet ist.

Antworten

• 200Stand.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  verfuegbar	boolean	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.

Speichert das FCM-Token der App. Ein Token, das schon einem anderen Konto gehört, wandert zum aufrufenden Konto (Kontowechsel auf dem Gerät). Höchstens 5 Geräte je Konto — ältere weichen. Body höchstens 4 KB.

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

application/json· erforderlich

Antworten

• 200Gespeichert.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  ok	true	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 400Ungültiges JSON, Token oder Plattform.

  application/json

• 403Die Anfrage kam nicht von StockPilot selbst (Schutz vor fremd ausgelösten Anfragen). Wird bei ändernden Aufrufen aus dem Browser mit fremdem Origin ausgelöst.

  application/json

• 413Zu groß.

  application/json

• 500Datenbankfehler.

  application/json

• 503Mitteilungen in der App sind serverseitig nicht eingerichtet.

  application/json

Läuft auch beim Abmelden aus der App, wenn die Sitzung schon beendet ist. Mit Sitzung nur eigene Geräte; ohne genügt das Token (kennt nur das Gerät).

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

application/json· erforderlich

Antworten

• 200Entfernt (auch, wenn es das Gerät nicht gab).

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  ok	true	ja

• 400Ungültiges JSON oder Token.

  application/json

• 403Die Anfrage kam nicht von StockPilot selbst (Schutz vor fremd ausgelösten Anfragen). Wird bei ändernden Aufrufen aus dem Browser mit fremdem Origin ausgelöst.

  application/json

• 500Datenbankfehler.

  application/json

Prüft das MHD in allen Haushalten der Person und legt eine Sammelmitteilung an (Glocke und Push).

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

Antworten

• 200Anzahl neu angelegter Mitteilungen.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  count	integer (≥ 0)	ja

• 401Keine gültige Sitzung.

  application/jsontext/plain

• 403Die Anfrage kam nicht von StockPilot selbst (Schutz vor fremd ausgelösten Anfragen). Wird bei ändernden Aufrufen aus dem Browser mit fremdem Origin ausgelöst.

  application/json

Sucht nach Postleitzahl (Anfang) oder Ortsname (Teilstring). Bei zu kurzer oder ungültiger Suche ist results leer, kein Fehler.

Antworten

• 200Treffer.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  results	Postleitzahl[]	ja
  results[].id	string	nein
  results[].plz	string	nein
  results[].place	string	nein
  results[].state	string	nein
  results[].lat	number	nein
  results[].lng	number	nein
  results[].population	integer | null	nein
  results[].areaKm2	number | null	nein

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.

Setzt „zuletzt gesehen“ und liefert die Zahl ungelesener Nachrichten. Die App ruft das regelmäßig auf, solange sie offen ist. Fehler bei der Zählung führen nur dazu, dass ungelesen fehlt.

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

Antworten

• 200Gemeldet.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  ok	true	ja
  ungelesen	integer (≥ 0)	nein

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 403Die Anfrage kam nicht von StockPilot selbst (Schutz vor fremd ausgelösten Anfragen). Wird bei ändernden Aufrufen aus dem Browser mit fremdem Origin ausgelöst.

  application/json

Eine Blockade wirkt in beide Richtungen: kein Chat, keine Anwesenheit, keine Profilbilder. Haushaltsmitglieder und die eigene Person lassen sich nicht blockieren.

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

application/json· erforderlich

Antworten

• 200Blockiert.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  ok	true	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 400Ungültige Eingabe, eigene Person oder Haushaltsmitglied.

  application/json

• 403Die Anfrage kam nicht von StockPilot selbst (Schutz vor fremd ausgelösten Anfragen). Wird bei ändernden Aufrufen aus dem Browser mit fremdem Origin ausgelöst.

  application/json

Nur wer blockiert hat, kann die Blockade aufheben.

Nur aus der eigenen Seite aufrufbar: Browser-Anfragen von fremden Seiten beantwortet die App mit 403.

Antworten

• 200Aufgehoben.

  application/json

  Felder

  Feld	Typ	Pflicht	Beschreibung
  ok	true	ja

• 307Keine gültige Sitzung: Die Route leitet zum Login weiter (HTTP 307, Location: /login — mit callbackUrl, wenn die Anfrage von einer eigenen Seite kam). Es gibt keinen 401 mit Fehlertext. Programmatische Clients sollten Weiterleitungen nicht folgen und die Sitzung erneuern.
• 403Die Anfrage kam nicht von StockPilot selbst (Schutz vor fremd ausgelösten Anfragen). Wird bei ändernden Aufrufen aus dem Browser mit fremdem Origin ausgelöst.

  application/json

• 404Es gab keine eigene Blockade.

  application/json