API 文档

支持 `X-API-Key` 和 `Authorization: Bearer` 两种携带方式。公开读端默认 scope 为 `events:read`，导出创建/取消使用 `exports:write`，导出查询/下载使用 `exports:read`，自助注册和密码重置不要求 API Key；客户后台登录态上下文、只读用量、只读账单摘要、只读成员清单、只读导出任务清单、只读组织审计日志清单、组织通知清单、通知保存视图和单条/批量通知已读/归档/隐藏/重试使用 Django session 且永不返回 raw API Key；登录态 API Key 签发和轮换仅在创建/轮换响应中一次性返回 raw key，登录态 API Key 轮换、权限更新和停用允许 owner/admin 管理同组织其他成员 Key，billing 仍只能管理本人 Key，后续只返回前缀和权限元数据；组织用量、账单摘要、账单通知偏好、通知收件箱、账单请求队列、账单请求活动时间线、成员列表、审计日志、审计导出、审计保存视图列表/详情和审计告警规则列表/详情/命中预览/指标/投递历史/投递详情使用 `organization:read`，成员邀请、通知已读/归档/隐藏/重试/批量处理、账单通知偏好更新、手工账单请求、账单请求补件、账单请求内部备注、审计 legal hold、审计保存视图创建/更新/删除和审计告警规则创建/更新/删除/测试发送/投递重试使用 `organization:write`；邀请接受使用邮件中的一次性令牌；API Key 和组织月额度超额都会返回 429。

curl -sS 'https://example.com/api/v1/events/?page=1&page_size=5'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  'https://example.com/api/v1/events/?disease=measles'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  'https://example.com/api/v1/organization/usage/'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  'https://example.com/api/v1/organization/billing/summary/'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  'https://example.com/api/v1/organization/billing/notification-preferences/'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  'https://example.com/api/v1/organization/notifications/?alert_type=billing_request_customer_notification&status=failed'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  'https://example.com/api/v1/organization/notifications/summary/?visibility_state=all&read_state=unread'

curl -sS \
  -X PATCH \
  -H 'X-API-Key: epic_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"customer_notifications_enabled":true,"assignee_notifications_enabled":false,"reason":"contract support window"}' \
  'https://example.com/api/v1/organization/billing/notification-preferences/'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  'https://example.com/api/v1/organization/billing/requests/?assigned_to=unassigned&overdue=true'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"action":"request_plan_change","requested_plan":"enterprise","message":"Need annual contract"}' \
  'https://example.com/api/v1/organization/billing/requests/'

curl -sS \
  -X PATCH \
  -H 'X-API-Key: epic_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"assigned_to":"me","status":"in_review","status_note":"Finance owner picked this up"}' \
  'https://example.com/api/v1/organization/billing/requests/{request_uid}/'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  'https://example.com/api/v1/organization/billing/requests/{request_uid}/timeline/'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"message":"Uploaded purchase order and billing contact"}' \
  'https://example.com/api/v1/organization/billing/requests/{request_uid}/supplements/'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"message":"Internal finance follow-up is assigned"}' \
  'https://example.com/api/v1/organization/billing/requests/{request_uid}/notes/'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  'https://example.com/api/v1/organization/audit-logs/?q=owner&action=organization_member_update&actor=ops@example.org&created_from=2026-05-01'

curl -L -o audit.csv \
  -H 'X-API-Key: epic_live_...' \
  'https://example.com/api/v1/organization/audit-logs/export/?q=owner&action=organization_member_update&created_from=2026-05-01'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Owner audit view","filter_payload":{"q":"owner","action":"organization_member_update"}}' \
  'https://example.com/api/v1/organization/audit-saved-views/'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"is_default":true,"shared_with_organization":true}' \
  'https://example.com/api/v1/organization/audit-saved-views/{view_uid}/'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"active":true,"reason":"contract dispute","legal_hold_until":"2026-12-31"}' \
  'https://example.com/api/v1/organization/audit-logs/legal-hold/'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Legal hold alert","recipient":"audit@example.org","actions":["organization_audit_retention_update"],"target_types":["organization_audit_retention"],"metadata_active":true}' \
  'https://example.com/api/v1/organization/audit-alert-rules/'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"email":"analyst@example.org","role":"analyst"}' \
  'https://example.com/api/v1/organization/invitations/'

curl -sS \
  -H 'Content-Type: application/json' \
  -d '{"token":"invite_token_from_email","email":"analyst@example.org","username":"analyst","password":"change-me"}' \
  'https://example.com/api/v1/organization/invitations/{membership_uid}/accept/'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"format":"csv","filter":{"diseases":["measles"]}}' \
  'https://example.com/api/v1/data-exports/'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  'https://example.com/api/v1/data-exports/?status=pending'

curl -sS -X POST \
  -H 'X-API-Key: epic_live_...' \
  'https://example.com/api/v1/data-exports/{job_uid}/cancel/'

curl -L -o export.csv \
  -H 'X-API-Key: epic_live_...' \
  'https://example.com/api/v1/data-exports/{job_uid}/download/'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  'https://example.com/api/v1/data-exports/{job_uid}/signed-url/'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  'https://example.com/api/v1/organization/notifications/?q=invoice&read_state=unread&archive_state=active'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  'https://example.com/api/v1/organization/notifications/?visibility_state=hidden'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  'https://example.com/api/v1/organization/notifications/summary/?q=invoice&archive_state=active'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  'https://example.com/api/v1/organization/notifications/{delivery_uid}/'

curl -sS \
  -H 'X-API-Key: epic_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Failed invoice notices","filter_payload":{"q":"invoice","status":"failed","read_state":"unread","visibility_state":"visible"}}' \
  'https://example.com/api/v1/organization/notifications/saved-views/'

curl -sS \
  -X POST \
  -H 'X-API-Key: epic_live_...' \
  'https://example.com/api/v1/organization/notifications/{delivery_uid}/read/'

curl -sS \
  -X POST \
  -H 'X-API-Key: epic_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"archived":false}' \
  'https://example.com/api/v1/organization/notifications/{delivery_uid}/archive/'

curl -sS \
  -X POST \
  -H 'X-API-Key: epic_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"hidden":true}' \
  'https://example.com/api/v1/organization/notifications/{delivery_uid}/hide/'

curl -sS \
  -X POST \
  -H 'X-API-Key: epic_live_...' \
  'https://example.com/api/v1/organization/notifications/{delivery_uid}/retry/'

curl -sS \
  -X POST \
  -H 'X-API-Key: epic_live_...' \
  -H 'Content-Type: application/json' \
  -d '{"action":"retry","delivery_uids":["{delivery_uid}"]}' \
  'https://example.com/api/v1/organization/notifications/bulk/'

响应中会保留 `data_version`、`updated_at`、`ETag` 和 `Last-Modified` 等缓存字段。