Referenz

PUT /v1/ui

Die Seite einer App setzen: Feld, Antwort und Fehler.

Als Markdown öffnen

Mit PUT /v1/ui sagt dein Tool, welche Webseite eine App zeigt. Den Aufruf gibt es nur für Packlets der Art App.

Die Anleitung dazu: Eigene App bauen.

PUT /v1/ui

HTTP
PUT https://api.packlets.app/v1/ui
Authorization: Bearer <SAMY_KEY>
Content-Type: application/json
FeldTypPflichtBedeutung
pagehttps-Adresse, bis 2.048 ZeichenjaDie Seite, die die App zeigt.
JSON
{ "page": "https://dein-server.de/rechnungen" }

Was ein PUT bewirkt:

  • Die App zeigt ab jetzt diese Seite. Eine andere Adresse setzt du mit einem neuen PUT.
  • Der erste erfolgreiche PUT verbindet das Packlet: Die App zeigt „Verbunden!“.
  • Wechselt die Adresse auf einen anderen Host oder Port, fragt Samy beim nächsten Öffnen nach, bevor es die Seite lädt.

Einmal reicht. Was die Seite zeigt, bestimmt danach dein Server.

Antwort

JSON
{ "ok": true, "page": "https://dein-server.de/rechnungen" }

Fehler

StatuserrorWann
400invalid_bodypage fehlt, ist keine https-Adresse oder zu lang. details nennt Feld und Grund.
401missing_key, invalid_keySchlüssel fehlt oder ist falsch.
409wrong_kindDas Packlet ist ein Kanal, keine App.
429rate_limitedMehr als 60 Aufrufe in einer Minute.

Was du jeweils tun kannst, steht unter Fehlercodes.