URL công khai và endpoint

Tham chiếu

Dành cho:: Người vận hành máy chủ, Nhà phát triển

Trang này liệt kê các endpoint ReputeCast mà trình duyệt, nhà cung cấp gửi thư, công cụ giám sát hoặc một dịch vụ khác truy cập, được nhóm theo vai trò máy chủ phục vụ chúng.

Đường dẫn là tương đối so với URL công khai của bạn (http.public_url). Một tiến trình serve chạy các vai trò trong --role (mặc định cả ba, xem mở rộng với các vai trò web, ingest và worker): web phục vụ API, MCP, trang công khai, theo dõi và ứng dụng web; ingest phục vụ /hooks/…; tiến trình chỉ có vai trò worker không có HTTP listener. <token> là một giá trị có ký mà ReputeCast đặt vào liên kết; hãy coi mọi URL chứa token là bí mật.

Health và metrics

Được phục vụ bởi mọi tiến trình có vai trò web hoặc ingest.

Đường dẫn	Dùng để làm gì
`GET /healthz`	Liveness: `200 ok` khi tiến trình đang chạy.
`GET /readyz`	Readiness: `200 ready`, hoặc `503` khi cơ sở dữ liệu không trả lời trong vòng 2 giây.
`/metrics`	Metrics Prometheus, không cần xác thực. Nằm trên cổng chính khi `metrics.enabled` bật và `metrics.addr` để trống. Khi đặt `metrics.addr`, metrics chuyển sang địa chỉ đó (mọi đường dẫn), cho mọi vai trò, kể cả tiến trình chỉ có worker.

Health check, metrics và log liệt kê các chuỗi metric.

API và MCP

Được phục vụ bởi vai trò web.

Đường dẫn	Dùng để làm gì
`/api/v1/…`	REST API. Xem tài liệu tham chiếu API.
`/api/openapi.json`, `/api/openapi.yaml`	Tài liệu OpenAPI 3.1, không cần xác thực. `/api/openapi-3.0.json` và `/api/openapi-3.0.yaml` cung cấp OpenAPI 3.0.
mọi `/api/…` khác	Tài liệu problem `404` với mã `not_found`.
`/mcp`	Máy chủ MCP (Streamable HTTP) cho token tác tử `rc_agent_…`. Xem công cụ MCP.

Trang công khai

Được phục vụ bởi vai trò web tại /p/<workspace>/…, trong đó <workspace> là slug của không gian làm việc. Trên một tên miền tùy chỉnh đã xác minh, các trang này trả lời ở gốc của tên miền (xem tên miền tùy chỉnh). Đường dẫn trong bảng này là tương đối so với /p/<workspace>.

Đường dẫn	Dùng để làm gì
`/`	Trang chủ website khi website bản tin được bật; nếu không, chuyển hướng tới `/subscribe`.
`/subscribe`, `/subscribe/<form>`	Trang đăng ký trên ReputeCast, cho biểu mẫu mặc định hoặc cho một biểu mẫu cụ thể.
`/forms/<id>.js`	Script nhúng của một biểu mẫu đăng ký. Script gọi `/forms/<id>/session` và `/forms/<id>/submit`.
`/confirm/<token>`	Liên kết xác nhận của quy trình xác nhận hai bước (double opt-in).
`/preferences`, `/preferences/<token>`	Biểu mẫu “Gửi liên kết cho tôi qua email” để nhận liên kết qua email; trung tâm tùy chọn.
`/unsubscribe/<token>`	Trang hủy đăng ký. Một yêu cầu `POST` với nội dung `List-Unsubscribe=One-Click` là đích hủy đăng ký một lần nhấp theo RFC 8058.
`/view/<token>`	Xem email trong trình duyệt.
`/archive`, `/archive/<issue>`, `/archive.rss`, `/sitemap.xml`	Trang lưu trữ công khai, một số bản tin, nguồn cấp RSS của trang lưu trữ, và sitemap.
`/sms-terms`	Trang điều khoản tin nhắn.
`/poll/<token>/<answer>`, `/s/<slug>`	Trang trả lời bình chọn (phiếu được ghi nhận bằng yêu cầu `POST` của trang, không phải khi mở liên kết); trang khảo sát.
`/join/<code>`, `/referrals`, `/referrals/<token>`, `/leaderboard`, `/rewards/<token>`	Trang mời của chương trình giới thiệu, trang phần thưởng, bảng xếp hạng và tệp tải xuống phần thưởng.
`/recommends`, `/recommends/<token>`	Trang đề xuất.
`/upgrade`, `/upgrade/<tier>`, `/billing/<token>`, `/cancel/<token>`	Trang nâng cấp và Stripe Checkout, cổng thanh toán của Stripe, và trang hủy.
`/gift`, `/gift/redeem/<code>`	Mua và nhận một thuê bao quà tặng.
`/products`, `/products/<slug>`, `/buy/<product>`, `/d/<token>`, `/l/<token>`	Cửa hàng, trang sản phẩm, trang thanh toán, trang tải xuống và tệp tải xuống lead magnet.
`/<slug>`	Một trang đích hoặc trang bán hàng đã xuất bản (`/<slug>/event.ics` là tệp lịch của trang).
`/posts/<slug>`, `/tag/<slug>`, `/feed`	Bài viết trên website bản tin, trang thẻ và nguồn cấp RSS của website.
`/signin`, `/account`	Trang đăng nhập và trang tài khoản dành cho người đọc trên website.
`/push/…`	Các endpoint mà lời nhắc bật thông báo đẩy trên web dùng để đăng ký và hủy đăng ký một trình duyệt.

Hai đường dẫn nằm ngoài không gian làm việc:

/p/_/… phục vụ CSS, script và font dùng chung của các trang. GET /p/_/tls-check?domain=<host> trả lời 200 khi host là một tên miền tùy chỉnh đã xác minh và 404 nếu không phải, dùng cho thiết lập ask của on-demand TLS trong Caddy.
/p/<code> với một mã đối tác (XXXX-XXXX-XXXX) giải thích cách dán mã vào một hệ thống ReputeCast khác; mở đường dẫn này không làm tiêu mã.

Các trang mở qua liên kết có ký đều là noindex. Một yêu cầu HEAD tới trang có token không làm gì cả, nên trình quét liên kết không thể xác nhận, hủy đăng ký hay bình chọn. robots.txt của hệ thống chặn mọi thứ trừ /p/.

Tên miền tùy chỉnh

Khi tên miền tùy chỉnh của một không gian làm việc đã được xác minh (một CNAME trỏ tới host của hệ thống, các bản ghi A/AAAA khớp, hoặc bản ghi TXT _reputecast.<domain>), các trang công khai trả lời ở gốc của tên miền đó: https://news.acme.io/subscribe là cùng một trang với /p/acme-newsletter/subscribe. ReputeCast xác định không gian làm việc từ header Host, nên proxy của bạn phải chuyển tiếp header này nguyên vẹn.

Liên kết trên các trang phục vụ từ tên miền tùy chỉnh bỏ phần /p/<workspace>. Script, tệp giao diện và tài nguyên dùng chung giữ nguyên đường dẫn /p/<workspace>/… và /p/_/….
Tên miền tùy chỉnh có robots.txt và sitemap.xml riêng.
Email vẫn liên kết tới URL công khai.
Trên host của chính hệ thống, các đường dẫn gốc như /subscribe thuộc về ứng dụng web.

Gắn thương hiệu cho trang và dùng tên miền riêng trình bày bước DNS, còn reverse proxy và TLS trình bày chứng chỉ.

Theo dõi và liên kết rút gọn

Được phục vụ bởi vai trò web.

Đường dẫn	Dùng để làm gì
`/t/o/<token>`	Pixel theo dõi lượt mở (ảnh GIF 1×1).
`/t/c/<token>`	Theo dõi lượt nhấp: ghi nhận lượt nhấp và chuyển hướng tới liên kết trong thư. Đích nằm trong token có ký, nên đường dẫn này không thể bị lợi dụng làm open redirect.
`/t/p/<id>.<token>`	Lượt nhấp vào thông báo đẩy trên web: chuyển hướng tới liên kết của thông báo.
`/t/s/<code>`	Liên kết rút gọn SMS trên host của hệ thống. Trên một tên miền liên kết rút gọn SMS đã xác minh, mã sáu ký tự hoạt động ở gốc: `/<code>`.

Liên kết báo cáo

Đường dẫn	Dùng để làm gì
`/r/<token>`	Liên kết chia sẻ chỉ xem của một báo cáo chiến dịch, hoặc của một báo cáo tài trợ. Liên kết đã thu hồi hoặc hết hạn sẽ ngừng hoạt động. Được phục vụ bởi vai trò web.

Webhook

Được phục vụ bởi vai trò ingest. ReputeCast hiển thị URL chính xác, kèm token, khi bạn kết nối dịch vụ. Token không xác định nhận 404 và chữ ký sai nhận 401 (400 với Stripe).

Đường dẫn	Dùng để làm gì
`POST /hooks/<adapter>/<token>`	Sự kiện từ nhà cung cấp gửi thư. `<adapter>` là `ses`, `postmark`, `postal`, `brevo`, `resend`, `sparkpost`, `mailjet`, `mailgun`, `sendgrid`, `azureacs`, `smtp`, `httpgeneric` hoặc `community:<id>`.
`POST /hooks/sms/<adapter>/<token>`	Báo nhận SMS và tin nhắn đến (`twilio`, `vonage`, `plivo`, `telnyx`, `aws_eum`).
`POST /hooks/stripe/<token>`	Sự kiện thanh toán của Stripe.
`POST /hooks/shopify/<token>`, `POST /hooks/woocommerce/<token>`	Sự kiện cửa hàng.
`GET`, `POST /hooks/whatsapp/<workspace>`	Webhook WhatsApp của Meta: `GET` xác minh việc đăng ký, `POST` gửi sự kiện.

Sự kiện gửi thư và đồng bộ danh sách chặn gửi giải thích điều gì xảy ra với sự kiện từ nhà cung cấp gửi thư.

Callback đăng nhập và các đường dẫn khác

Được phục vụ bởi vai trò web.

Đường dẫn	Dùng để làm gì
`/auth/oidc/<slug>/callback`	Redirect URI của một nhà cung cấp SSO OIDC.
`/auth/social/<kind>/callback`	Redirect URI cho đăng nhập bằng Google, Microsoft và GitHub (`<kind>` = `google`, `microsoft`, `github`).
`/api/v1/placement/oauth/callback`	Redirect URI cho hộp thư thử (seed mailbox) được kết nối bằng OAuth.
`/integrations/shopify/app`, `/integrations/shopify/callback`	App URL và redirect URL của ứng dụng Shopify.
`/media/<id>/<file>`	Hình ảnh được tải lên thư viện media và dùng trong email và trang.
`/push/v1/…`, `/rc-push-sw.js`	Script lời nhắc bật thông báo đẩy trên web và service worker.
`/.well-known/acme-challenge/…`	Thử thách HTTP-01 của Let’s Encrypt cho chứng chỉ của SMTP relay.
`/partner/v1/…`	Giao thức có ký giữa các hệ thống ReputeCast cho đề xuất đối tác.
mọi đường dẫn khác	Ứng dụng web: `/sign-in`, `/setup`, `/invite/<token>`, `/reset-password/<token>`, `/w/<workspace>/…`. Được gửi kèm `noindex`.

Liên quan

Reverse proxy và TLS chuyển tiếp các đường dẫn này, kể cả streaming cho /mcp và màn hình theo dõi trực tiếp.
Hủy đăng ký một lần nhấp (RFC 8058) cho thấy các header trỏ tới /unsubscribe/<token>.
Trang đăng ký, tùy chọn và hủy đăng ký mô tả các trang công khai.