Завантаження документації...
Підготовка контенту платформи Ring
Concepts, value, and typical clone scenarios — less code.
Concepts, value, and typical clone scenarios — less code.
Підготовка контенту платформи Ring
Підготовка контенту платформи Ring
Підготовка контенту платформи Ring
Ring Platform exposes ~244 App Router route handlers under /api/* — the live surface your clone, mobile clients, cron jobs, webhooks, and MCP agents call. This page is the map: founders browse capabilities; developers get auth rules, domain docs, and verified path families.
Use the Founder / Developer tabs in the docs sidebar. Founders get a visual API tree; developers get contracts, secrets, and deep links into domain pages.
An API endpoint is a named door on your Ring server. The browser, Telegram bot, payment gateway, or an AI agent knocks on that door with a short request; Ring answers with data or performs an action (send a message, take a payment, list products).
You do not need to write code to understand the map:
/api/mcp/v1/*) are the same business domains, shaped for AI agents and automation.Tap a leaf in the upper tree. The lower panel shows a short summary and the HTTP methods for that door.
| Family | What it unlocks | Start here |
|---|---|---|
| Auth & identity | Sign-in, sessions, wallet login | Authentication |
| Messaging & calls | Chats, typing, call invites | Messaging |
| Notifications | Inbox + mobile push (FCM) | Notifications |
| Entities & opportunities | Orgs, projects, matching | Entities · Opportunities |
| Store & shipping | Catalog, checkout, Nova Poshta | Store |
| Membership & payments | Subscriptions, WayForPay / Stripe | Payments |
| Wallet & credits |
Cart state lives in the browser (ring_cart) — there is no public “cart REST API”. Checkout and payments are the store money path.
New to Ring? Getting Started · API integration examples · for developers index.
Ring Platform exposes ~244 App Router route handlers under /api/* — the live surface your clone, mobile clients, cron jobs, webhooks, and MCP agents call. This page is the map: founders browse capabilities; developers get auth rules, domain docs, and verified path families.
Use the Founder / Developer tabs in the docs sidebar. Founders get a visual API tree; developers get contracts, secrets, and deep links into domain pages.
An API endpoint is a named door on your Ring server. The browser, Telegram bot, payment gateway, or an AI agent knocks on that door with a short request; Ring answers with data or performs an action (send a message, take a payment, list products).
You do not need to write code to understand the map:
/api/mcp/v1/*) are the same business domains, shaped for AI agents and automation.Tap a leaf in the upper tree. The lower panel shows a short summary and the HTTP methods for that door.
| Family | What it unlocks | Start here |
|---|---|---|
| Auth & identity | Sign-in, sessions, wallet login | Authentication |
| Messaging & calls | Chats, typing, call invites | Messaging |
| Notifications | Inbox + mobile push (FCM) | Notifications |
| Entities & opportunities | Orgs, projects, matching | Entities · Opportunities |
| Store & shipping | Catalog, checkout, Nova Poshta | Store |
| Membership & payments | Subscriptions, WayForPay / Stripe | Payments |
| Wallet & credits |
Cart state lives in the browser (ring_cart) — there is no public “cart REST API”. Checkout and payments are the store money path.
New to Ring? Getting Started · API integration examples · for developers index.
Ring Platform exposes ~244 App Router route handlers under /api/* — the live surface your clone, mobile clients, cron jobs, webhooks, and MCP agents call. This page is the map: founders browse capabilities; developers get auth rules, domain docs, and verified path families.
Use the Founder / Developer tabs in the docs sidebar. Founders get a visual API tree; developers get contracts, secrets, and deep links into domain pages.
An API endpoint is a named door on your Ring server. The browser, Telegram bot, payment gateway, or an AI agent knocks on that door with a short request; Ring answers with data or performs an action (send a message, take a payment, list products).
You do not need to write code to understand the map:
/api/mcp/v1/*) are the same business domains, shaped for AI agents and automation.Tap a leaf in the upper tree. The lower panel shows a short summary and the HTTP methods for that door.
| Family | What it unlocks | Start here |
|---|---|---|
| Auth & identity | Sign-in, sessions, wallet login | Authentication |
| Messaging & calls | Chats, typing, call invites | Messaging |
| Notifications | Inbox + mobile push (FCM) | Notifications |
| Entities & opportunities | Orgs, projects, matching | Entities · Opportunities |
| Store & shipping | Catalog, checkout, Nova Poshta | Store |
| Membership & payments | Subscriptions, WayForPay / Stripe | Payments |
| Wallet & credits |
Cart state lives in the browser (ring_cart) — there is no public “cart REST API”. Checkout and payments are the store money path.
New to Ring? Getting Started · API integration examples · for developers index.
| Credit top-up, transfers, tokens |
| Wallet |
| Admin & ops | Users, email CRM, fraud, processes | Admin · Email AI-CRM |
| MCP agent API | Same domains for agents | Ring MCP |
| Realtime tunnel | Live subscribe / publish | Tunnel protocol |
/api/auth/[...nextauth], username check, crypto nonce, Telegram callback |
| Entities | Entities | /api/entities, /create, /[id]/* |
| Opportunities | Opportunities | /api/opportunities, create/update/search/upload |
| Messaging | Messaging | /api/conversations/*, /api/messages/*, /api/webrtc/ice-servers |
| Notifications | Notifications | /api/notifications/*, FCM register/test |
| Wallet | Wallet | /api/wallet/* credit, desk, token, transfer |
| Store | Store | /api/store/* products, checkout, orders, payments |
| Admin | Admin | /api/admin/* users, payments, moderation, web3, processes |
| Email AI-CRM | Email AI-CRM | /api/admin/email/*, /api/webhooks/email/inbound, cron email |
| Tunnel | Tunnel protocol | /api/tunnel/* |
| MCP | Ring MCP | /api/mcp/v1/* |
| Payments | PaymentConductor | membership + store + WayForPay/Stripe webhooks |
| Client | Auth |
|---|---|
| Browser / same-origin React | Auth.js v5 session cookie (credentials: 'include'). No manual Bearer in client UI code. |
| Cron | Authorization: Bearer <CRON_SECRET> |
| Webhooks (WayForPay, Stripe, email inbound, Telegram bot) | Provider signature / shared secret per route |
| MCP agents | Authorization: Bearer <RING_MCP_ACCESS_KEY> on /api/mcp/v1/* |
Base URL = your clone origin + /api (local: http://localhost:3000/api).
Integration patterns: API integration examples.
| Family | ~Routes | Notes |
|---|---|---|
MCP (/api/mcp/v1) | 42 | Agent mirror of core domains + generative media |
| Admin | 41 | Users, email CRM, fraud, matcher, processes, public pools, web3 |
| Wallet | 16 | Ensure, credit, desk, token, transfer |
| Cron | 13 | Settlements, subscriptions, email, cleanup, train |
| Store + vendor + shipping + ERP | 17 | Checkout, WayForPay, reviews, Nova Poshta, stock init |
| Tunnel | 11 | Token, subscribe, SSE, poll, publish, heartbeat |
| News + publications + collab | 16 | Newsroom, RSS, promotion webhook, publications |
| Conversations + messages + comments + WebRTC | 14 | Chat, reactions, ICE |
| Entities + opportunities + confidential | 16 | Core Ring graph |
| Membership + payment webhooks + prices | 11 | Card/credit/PayPal/token + WFP/Stripe |
| Auth + account + set-user-role | 7 | Auth.js + helpers |
| Notifications + FCM | 7 | Inbox + push |
| Analytics + platform + health/info/uploads | 12 | Beacons, stats, probes |
| Web3 / NFT / refcodes / pools | 10 | Listings, pools, referral mint/track |
| Verification | 3 | Procedures + documents |
| Profile / users / settings / ring contacts | 9 | People plane |
| Misc (images, citations, agents provision, telegram, test-db, balance) | ~8 | Generative + ops helpers |
Visual browse (same widget as Founder tab):
In-app live updates use Tunnel Protocol (native WSS on k8s; SSE/poll fallback). See Tunnel protocol and Realtime architecture.
| Credit top-up, transfers, tokens |
| Wallet |
| Admin & ops | Users, email CRM, fraud, processes | Admin · Email AI-CRM |
| MCP agent API | Same domains for agents | Ring MCP |
| Realtime tunnel | Live subscribe / publish | Tunnel protocol |
/api/auth/[...nextauth], username check, crypto nonce, Telegram callback |
| Entities | Entities | /api/entities, /create, /[id]/* |
| Opportunities | Opportunities | /api/opportunities, create/update/search/upload |
| Messaging | Messaging | /api/conversations/*, /api/messages/*, /api/webrtc/ice-servers |
| Notifications | Notifications | /api/notifications/*, FCM register/test |
| Wallet | Wallet | /api/wallet/* credit, desk, token, transfer |
| Store | Store | /api/store/* products, checkout, orders, payments |
| Admin | Admin | /api/admin/* users, payments, moderation, web3, processes |
| Email AI-CRM | Email AI-CRM | /api/admin/email/*, /api/webhooks/email/inbound, cron email |
| Tunnel | Tunnel protocol | /api/tunnel/* |
| MCP | Ring MCP | /api/mcp/v1/* |
| Payments | PaymentConductor | membership + store + WayForPay/Stripe webhooks |
| Client | Auth |
|---|---|
| Browser / same-origin React | Auth.js v5 session cookie (credentials: 'include'). No manual Bearer in client UI code. |
| Cron | Authorization: Bearer <CRON_SECRET> |
| Webhooks (WayForPay, Stripe, email inbound, Telegram bot) | Provider signature / shared secret per route |
| MCP agents | Authorization: Bearer <RING_MCP_ACCESS_KEY> on /api/mcp/v1/* |
Base URL = your clone origin + /api (local: http://localhost:3000/api).
Integration patterns: API integration examples.
| Family | ~Routes | Notes |
|---|---|---|
MCP (/api/mcp/v1) | 42 | Agent mirror of core domains + generative media |
| Admin | 41 | Users, email CRM, fraud, matcher, processes, public pools, web3 |
| Wallet | 16 | Ensure, credit, desk, token, transfer |
| Cron | 13 | Settlements, subscriptions, email, cleanup, train |
| Store + vendor + shipping + ERP | 17 | Checkout, WayForPay, reviews, Nova Poshta, stock init |
| Tunnel | 11 | Token, subscribe, SSE, poll, publish, heartbeat |
| News + publications + collab | 16 | Newsroom, RSS, promotion webhook, publications |
| Conversations + messages + comments + WebRTC | 14 | Chat, reactions, ICE |
| Entities + opportunities + confidential | 16 | Core Ring graph |
| Membership + payment webhooks + prices | 11 | Card/credit/PayPal/token + WFP/Stripe |
| Auth + account + set-user-role | 7 | Auth.js + helpers |
| Notifications + FCM | 7 | Inbox + push |
| Analytics + platform + health/info/uploads | 12 | Beacons, stats, probes |
| Web3 / NFT / refcodes / pools | 10 | Listings, pools, referral mint/track |
| Verification | 3 | Procedures + documents |
| Profile / users / settings / ring contacts | 9 | People plane |
| Misc (images, citations, agents provision, telegram, test-db, balance) | ~8 | Generative + ops helpers |
Visual browse (same widget as Founder tab):
In-app live updates use Tunnel Protocol (native WSS on k8s; SSE/poll fallback). See Tunnel protocol and Realtime architecture.
| Credit top-up, transfers, tokens |
| Wallet |
| Admin & ops | Users, email CRM, fraud, processes | Admin · Email AI-CRM |
| MCP agent API | Same domains for agents | Ring MCP |
| Realtime tunnel | Live subscribe / publish | Tunnel protocol |
/api/auth/[...nextauth], username check, crypto nonce, Telegram callback |
| Entities | Entities | /api/entities, /create, /[id]/* |
| Opportunities | Opportunities | /api/opportunities, create/update/search/upload |
| Messaging | Messaging | /api/conversations/*, /api/messages/*, /api/webrtc/ice-servers |
| Notifications | Notifications | /api/notifications/*, FCM register/test |
| Wallet | Wallet | /api/wallet/* credit, desk, token, transfer |
| Store | Store | /api/store/* products, checkout, orders, payments |
| Admin | Admin | /api/admin/* users, payments, moderation, web3, processes |
| Email AI-CRM | Email AI-CRM | /api/admin/email/*, /api/webhooks/email/inbound, cron email |
| Tunnel | Tunnel protocol | /api/tunnel/* |
| MCP | Ring MCP | /api/mcp/v1/* |
| Payments | PaymentConductor | membership + store + WayForPay/Stripe webhooks |
| Client | Auth |
|---|---|
| Browser / same-origin React | Auth.js v5 session cookie (credentials: 'include'). No manual Bearer in client UI code. |
| Cron | Authorization: Bearer <CRON_SECRET> |
| Webhooks (WayForPay, Stripe, email inbound, Telegram bot) | Provider signature / shared secret per route |
| MCP agents | Authorization: Bearer <RING_MCP_ACCESS_KEY> on /api/mcp/v1/* |
Base URL = your clone origin + /api (local: http://localhost:3000/api).
Integration patterns: API integration examples.
| Family | ~Routes | Notes |
|---|---|---|
MCP (/api/mcp/v1) | 42 | Agent mirror of core domains + generative media |
| Admin | 41 | Users, email CRM, fraud, matcher, processes, public pools, web3 |
| Wallet | 16 | Ensure, credit, desk, token, transfer |
| Cron | 13 | Settlements, subscriptions, email, cleanup, train |
| Store + vendor + shipping + ERP | 17 | Checkout, WayForPay, reviews, Nova Poshta, stock init |
| Tunnel | 11 | Token, subscribe, SSE, poll, publish, heartbeat |
| News + publications + collab | 16 | Newsroom, RSS, promotion webhook, publications |
| Conversations + messages + comments + WebRTC | 14 | Chat, reactions, ICE |
| Entities + opportunities + confidential | 16 | Core Ring graph |
| Membership + payment webhooks + prices | 11 | Card/credit/PayPal/token + WFP/Stripe |
| Auth + account + set-user-role | 7 | Auth.js + helpers |
| Notifications + FCM | 7 | Inbox + push |
| Analytics + platform + health/info/uploads | 12 | Beacons, stats, probes |
| Web3 / NFT / refcodes / pools | 10 | Listings, pools, referral mint/track |
| Verification | 3 | Procedures + documents |
| Profile / users / settings / ring contacts | 9 | People plane |
| Misc (images, citations, agents provision, telegram, test-db, balance) | ~8 | Generative + ops helpers |
Visual browse (same widget as Founder tab):
In-app live updates use Tunnel Protocol (native WSS on k8s; SSE/poll fallback). See Tunnel protocol and Realtime architecture.