本文へ移動
TurnitPass
開発者API v1API キーを発行
ドキュメントを見る

開発者通知

アカウント、請求、API の通知を責任者へ届ける

通知は運用面です。残高低下、キー操作、請求変更、API 障害、製品更新はワークスペース所有者に届く必要があります。

REST API v1

開発者向けプラットフォーム

概要

ワークスペース
POSTinternal event
アカウント単位
通知ペイロード
internal event
{
  "type": "low_word_balance",
  "workspace_id": "user_workspace",
  "words_remaining": 2858,
  "action_url": "/dashboard#workspace-billing"
}

説明

01

残高低下

Humanizer や detector が語数切れになる前にチームへ知らせます。

02

キーイベント

作成、失効、不審な認証失敗を可視化します。

03

製品更新

開発者向けの変更は公開 changelog にまとめます。

通知モデル

通知は実際の運用リスクに対応する

1

残高の変化

残語数が本番ジョブを止めうる水準になったら所有者へ知らせます。

2

キーのライフサイクル

キー作成・失効、または認証失敗の急増を通知します。

3

請求イベント

成功したアップグレード、支払い失敗、更新問題、ポータル変更を届けます。

4

API 互換性

新しいエンドポイント、応答フィールド、文書化された上限変更は changelog を使います。

通知経路

各メッセージに含める内容

語数が少ない
残高とプラン残語数、プラン、請求または料金へのリンクを含めます。
キー作成
名前と時刻キー名と時刻を含め、平文トークンは含めません。
支払い問題
請求アクションログイン後のワークスペース請求とポータルへリンクします。
API 変更
ドキュメントリンク変わったリファレンスまたは changelog の該当箇所を示します。
実装上の注意。 このページは通知モデルを説明します。送信ドメイン、サポート受信箱、アカウント設定が固まってからメール配信をつなぎます。
次に、ワークフローへ接続します。続きを読む