hosting
POST /v1/sites/{siteId}/ide-events
Record something the customer did in the site's web editor.
認証
このエンドポイントは公開されています。認証情報や組織情報は不要で、当社のマーケティングサイトやAI回答エンジンが読み取っているものと同じです。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/ide-events \
-H "Content-Type: application/json" \
-d '{ "event": <string<file_saved, ai_applied, file_restored, terminal_opened>> }'ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Appends one row to the site's activity log for an action taken in the editor — a file saved, an AI suggestion applied, an earlier version restored, a terminal opened. Editing the files of a live website is a privileged action and is logged as one. The acting person is taken from the **grant**, which the engine signed when the editor was opened, and never from the request: the caller runs inside the cage being audited, so anything it claimed about identity would be a claim by its own subject. The event name is mapped to a closed set of audit actions for the same reason. **This records what the editor did.** A customer with a terminal can change their own files without it, so it is an accountability trail for actions taken through our tool rather than a filesystem-level record. The filesystem-level answer is the site backup.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
event | string<file_saved, ai_applied, file_restored, terminal_opened> | はい | A closed set. The caller runs inside the cage being audited, so it names an event and the engine chooses the audit action — a log whose rows can be authored by their own subject… |
path | string | いいえ | The file, relative to the site. Truncated to 512 characters. |
bytes_before | integer | いいえ | Size of the file before the write, so a truncation is visible in the log. |
bytes_after | integer | いいえ | — |
version | string | いいえ | Which kept version was restored, for a `file_restored` event. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
recorded | boolean | はい | — |
このエンドポイントが返すエラー
404 · 422