Проекты

Get User Projects

get

Получение списка проектов текущего пользователя.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
skipintegerOptional

Количество пропускаемых записей

Default: 0
limitinteger · min: 1 · max: 100Optional

Максимальное количество записей

Default: 100
Responses
200

Successful Response

application/json
get
/api/projects
GET /api/projects HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 1,
    "user_id": 1,
    "subdomain": "text",
    "name": "text",
    "description": "text",
    "created_at": "2025-12-08T00:22:42.727Z",
    "updated_at": "2025-12-08T00:22:42.727Z"
  }
]

Create Project

post

Создание нового проекта.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

Схема для создания нового проекта

subdomainstring · min: 3 · max: 63Required

Уникальный поддомен проекта (только латиница, цифры и дефисы)

namestring · min: 1 · max: 255Required

Название проекта

descriptionany ofOptional

Описание проекта

string · max: 1000Optional
or
nullOptional
Responses
post
/api/projects
POST /api/projects HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "subdomain": "text",
  "name": "text",
  "description": "text"
}
{
  "id": 1,
  "user_id": 1,
  "subdomain": "text",
  "name": "text",
  "description": "text",
  "created_at": "2025-12-08T00:22:42.727Z",
  "updated_at": "2025-12-08T00:22:42.727Z"
}

Check Subdomain Availability

get

Проверка доступности поддомена.

Query parameters
subdomainstring · min: 3 · max: 63Required
Responses
200

Successful Response

application/json
get
/api/projects/check-subdomain
GET /api/projects/check-subdomain?subdomain=text HTTP/1.1
Host: 
Accept: */*

{
  "subdomain": "text",
  "available": true,
  "message": "text"
}

Get Project

get

Получение проекта по ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
project_idintegerRequired
Responses
200

Successful Response

application/json
get
/api/projects/{project_id}
GET /api/projects/{project_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "user_id": 1,
  "subdomain": "text",
  "name": "text",
  "description": "text",
  "created_at": "2025-12-08T00:22:42.727Z",
  "updated_at": "2025-12-08T00:22:42.727Z"
}

Delete Project

delete

Удаление проекта.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
project_idintegerRequired
Responses
delete
/api/projects/{project_id}
DELETE /api/projects/{project_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update Project

patch

Обновление проекта.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
project_idintegerRequired
Body

Схема для обновления проекта

subdomainany ofOptional

Уникальный поддомен проекта (только латиница, цифры и дефисы)

string · min: 3 · max: 63Optional
or
nullOptional
nameany ofOptional

Название проекта

string · min: 1 · max: 255Optional
or
nullOptional
descriptionany ofOptional

Описание проекта

string · max: 1000Optional
or
nullOptional
Responses
200

Successful Response

application/json
patch
/api/projects/{project_id}
PATCH /api/projects/{project_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "subdomain": "text",
  "name": "text",
  "description": "text"
}
{
  "id": 1,
  "user_id": 1,
  "subdomain": "text",
  "name": "text",
  "description": "text",
  "created_at": "2025-12-08T00:22:42.727Z",
  "updated_at": "2025-12-08T00:22:42.727Z"
}

Publish Project

post

Публикация проекта - генерация HTML файлов для страниц.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
project_idintegerRequired
Body

Схема запроса на публикацию проекта

page_idsany ofOptional

Список ID страниц для публикации. Если не указан, публикуются все страницы

integer[]Optional
or
nullOptional
Responses
200

Successful Response

application/json
post
/api/projects/{project_id}/publish
POST /api/projects/{project_id}/publish HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "page_ids": [
    1
  ]
}
{
  "project_id": 1,
  "subdomain": "text",
  "published_pages": [
    {
      "page_id": 1,
      "page_name": "text",
      "slug": "text",
      "file_path": "text",
      "url": "text"
    }
  ],
  "total_pages": 1,
  "message": "text"
}
ПредыдущаяАутентификацияСледующаяСтраницы

Последнее обновление