Публичное API Funnelica

Содержание

• Базовый URL, заголовки, ответы
• Формы (public submit)
• Публичные страницы и трекинг
• Публичные воронки
• Checkout и заказы
• Резолв доменов
• Email-трекинг и отписка
• Студенческий портал

Базовый URL, заголовки, ответы

Базовый URL зависит от окружения. В dev обычно используется http://localhost:4000. В проде — адрес backend, например https://api.example.com. Если backend проксируется на /api, используйте этот префикс.

{
  "statusCode": 400,
  "message": "Form is not available",
  "error": "Bad Request",
  "path": "/forms/xxx/submit",
  "timestamp": "2025-12-19T12:00:00.000Z",
  "requestId": "..."
}

Формы (public submit)

Публичная отправка формы. Workspace определяется по домену формы (Host). Поле payload обязательно, остальные — опциональны.

{
  "name": "Иван",
  "email": "ivan@example.com",
  "phone": "+7 (999) 000-00-00",
  "company": "ООО Пример",
  "pageUrl": "https://site.example.com/landing",
  "source": "form:Landing",
  "utm": { "utm_source": "ads", "utm_campaign": "winter" },
  "payload": {
    "question": "Что вы предлагаете?"
  }
}

Ответ:

{
  "submissionId": "sub_...",
  "contactId": "contact_...",
  "status": "received"
}

Публичные страницы и трекинг

Получение страницы для рендера и трекинг просмотров. Если домен не совпадает с workspace, передайте x-tenant-host илиworkspaceId в query. Для создания/привязки контакта можно передать email, phone, nameв query.

Возвращает страницу (включая schema) и данные A/B-эксперимента.

{
  "id": "page_...",
  "name": "Landing",
  "path": "/landing",
  "status": "published",
  "schema": { "editor": "grapesjs", "html": "...", "css": "..." },
  "experiment": { "experimentId": "exp_...", "variant": "A" }
}

{
  "contactId": "contact_...",
  "sessionId": "session_...",
  "utm": { "utm_source": "ads" }
}

Ответ: { "success": true, "viewId": "view_..." }

Публичные воронки

{
  "id": "funnel_...",
  "name": "Воронка запуска",
  "steps": [{ "id": "step_1", "type": "page", "pageId": "page_..." }],
  "status": "active"
}

{
  "contactId": "contact_...",
  "metadata": { "utm_campaign": "winter" }
}

Ответ: { "success": true }

Ответ: { "nextStepId": "step_2" }

Checkout и заказы

Возвращает настройки checkout (продукт, цена, настройки оплаты).

{
  "checkoutPath": "/checkout/abc",
  "couponCode": "SUMMER10"
}

{
  "checkoutPath": "/checkout/abc",
  "email": "ivan@example.com",
  "phone": "+7 (999) 000-00-00",
  "name": "Иван",
  "company": "ООО Пример",
  "couponCode": "SUMMER10",
  "referralCode": "ref-123"
}

Ответ содержит данные заказа и paymentUrl для оплаты.

Возвращает URL для редиректа после оплаты (thank-you/upsell).

{
  "action": "accept",
  "type": "upsell",
  "checkoutPath": "/checkout/upsell-1"
}

Резолв доменов

{
  "matched": true,
  "workspaceId": "workspace_...",
  "slug": "company",
  "kind": "sites",
  "domainId": "domain_...",
  "host": "company.sites.example.com"
}

Email-трекинг и отписка

Студенческий портал

Вход по коду подтверждения. Ответ на запрос кода всегда успешный — это защищает от перебора почтовых адресов. Если известен workspace, передавайте workspaceId.

{
  "email": "student@example.com",
  "workspaceId": "workspace_..." // опционально
}

{
  "email": "student@example.com",
  "code": "123456",
  "workspaceId": "workspace_..." // опционально
}

Ответ: { accessToken, refreshToken, contact }

{ "refreshToken": "..." }

Защищенные эндпойнты требуют Authorization: Bearer <accessToken>:/student/me,/student/dashboard,/student/courses,/student/enrollments/:id/...