Frontend Public API

Управление платформой: авторизация, компании, биллинг

Интерактивная документация¶

Эндпоинты¶

POST /frontend/api/companies¶

Create Company

Создание новой компании

Аргументы: request_data: Данные компании request: FastAPI request container: DI контейнер

Возвращает: Информация о созданной компании и URL для редиректа

Запрос¶

Content-Type: application/json

{
  "name": <string> (обязательно),  // 
  "slug": <string> (обязательно),  // 
}

Ответ¶

• 200: Successful Response
• 422: Validation Error

POST /frontend/api/companies/check-slug¶

Check Slug

Проверка доступности slug для субдомена

Аргументы: request: Запрос с slug container: DI контейнер

Возвращает: Информация о доступности slug

Запрос¶

Content-Type: application/json

{
  "slug": <string> (обязательно),  // 
}

Ответ¶

• 200: Successful Response
• 422: Validation Error

GET /frontend/api/companies/me¶

Get My Companies

Возвращает компании текущего пользователя с subdomain и ролями.

Ответ¶

• 200: Successful Response

DELETE /frontend/api/companies/{company_id}/system-access¶

Leave Company As System Member

Параметры¶

• company_id (path, string) (обязательно):

Ответ¶

• 200: Successful Response
• 422: Validation Error

POST /frontend/api/companies/{company_id}/system-access¶

Enter Company As System Member

Параметры¶

• company_id (path, string) (обязательно):

Запрос¶

Content-Type: application/json

{
  "role": <string> (обязательно),  // 
}

Ответ¶

• 200: Successful Response
• 422: Validation Error