Zum Inhalt springen
TurnitPass
EntwicklerAPI v1API-Schlüssel erstellen
Dokumentation durchsuchen

EntwicklerBenachrichtigungen

Konto-, Abrechnungs- und API-Hinweise klar zuordnen

Hinweise sind eine Betriebsfläche: niedriges Guthaben, Schlüsselaktivität, Abrechnungsänderungen, API-Fehler und Produktupdates sollen den Arbeitsbereichsinhaber erreichen.

REST API v1

Ihre Plattform

Übersicht

Arbeitsbereich
POSTinternal event
kontobezogen
Hinweis-Payload
internal event
{
  "type": "low_word_balance",
  "workspace_id": "user_workspace",
  "words_remaining": 2858,
  "action_url": "/dashboard#workspace-billing"
}

Hinweise

01

Niedriges Guthaben

Teams warnen, bevor Humanizer- oder Detektoranfragen ohne Wörter bleiben.

02

Schlüsselereignisse

Erstellung, Widerruf und auffällige Authentifizierungsfehler sichtbar machen.

03

Produktupdates

Entwicklerrelevante Änderungen erscheinen im öffentlichen Changelog.

Hinweismodell

Hinweise sollen echtes Betriebsrisiko abbilden

1

Guthabenänderungen

Kontoinhaber benachrichtigen, wenn restliche Wörter Produktionsjobs blockieren könnten.

2

Schlüssel-Lebenszyklus

Benachrichtigen, wenn ein Schlüssel erstellt oder widerrufen wird oder Authentifizierungsfehler zunehmen.

3

Abrechnungsereignisse

Erfolgreiche Upgrades, fehlgeschlagene Zahlungen, Verlängerungsprobleme und Portaländerungen weiterleiten.

4

API-Kompatibilität

Changelog-Einträge für neue Endpunkte, Antwortfelder und dokumentierte Limitänderungen nutzen.

Hinweiswege

Was jede Nachricht enthalten sollte

Wenige Wörter
Guthaben und TarifRestwörter, Tarif und einen Link zur Abrechnung oder Preisübersicht angeben.
Schlüssel erstellt
Name und ZeitSchlüsselbezeichnung und Zeitstempel angeben, niemals das Klartext-Token.
Zahlungsproblem
AbrechnungsaktionNach der Anmeldung zu Arbeitsbereichsabrechnung und Portal verlinken.
API-Änderung
DokumentationslinkAuf den geänderten Referenz- oder Changelog-Abschnitt verweisen.
Hinweis zur Umsetzung. Diese Seite beschreibt das Hinweismodell. Der E-Mail-Versand folgt, sobald Absenderdomain, Supportpostfach und Kontopräferenzen feststehen.
Als Nächstes in Ihren Workflow einbinden.Weiterlesen