INTEGRITY Документация

Создание зала ожидания

Вы можете создать зал ожидания на панели управления или через API.

  1. В своём приложении перейдите к Трафик > Waiting Room.
  2. Выберите Создание.
  3. Настроить настройки для вашего зала ожидания. Дополнительные рекомендации см. в Рекомендации.
  4. Выберите Далее.
  5. В этом разделе можно выбрать, включать ли Turnstile для вашего зала ожидания. Если вы выберете Да, вам нужно будет выбрать Режим виджета и определить действие на случай, если проверка Turnstile не пройдена. Доступные режимы виджета и действия зависят от вашего тарифного плана. См. Планы для дополнительных сведений.
  6. Если вы хотите настроить свой зал ожидания, при необходимости измените HTML и CSS. Если вы используете этот зал ожидания для управления трафиком мобильного приложения или API, включите переключатель JSON Response. Убедитесь, что у вас настроен JSON-совместимый ответ для вашего клиента (мобильного или веб-приложения).
  7. Выберите Код состояния очереди чтобы определить код состояния HTTP, который возвращается, когда пользователь находится в Waiting Room.
  8. Выберите Далее.
  9. Проверьте настройки перед сохранением. Если вы изменили зал ожидания, обязательно просмотреть результат.
  10. Выберите Save. Новый зал ожидания будет включён по умолчанию.

Чтобы создать Waiting Room через API, отправьте POST запрос к /zones/{zone_identifier}/waiting_rooms конечная точка:

Необходимые разрешения API-токена

Хотя бы одно из следующих права доступа токена требуется:
  • Waiting Rooms Write
Создание зала ожидания
curl "https://api.cloudflare.com/client/v4/zones/$ZONE_ID/waiting_rooms" \
	--request POST \
	--header "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
	--json '{
		"name": "shop_waiting_room",
		"description": "Waiting room for webshop",
		"host": "shop.example.com",
		"path": "/shop",
		"queue_all": true,
		"new_users_per_minute": 200,
		"total_active_users": 300,
		"session_duration": 1,
		"disable_session_renewal": false,
		"json_response_enabled": false,
		"queueing_method": "fifo",
		"queueing_status_code": 202,
		"cookie_attributes": {
				"samesite": "auto",
				"secure": "auto"
		}
	}'

Ответ содержит полное описание только что созданного Waiting Room.

Ответ
{
	"success": true,
	"errors": [],
	"messages": [],
	"result": [
		{
			"id": "1111111111111111111111",
			"created_on": "2023-01-01T05:20:00.12345Z",
			"modified_on": "2023-01-01T05:20:00.12345Z",
			"name": "shop_waiting_room",
			"description": "Waiting room for webshop",
			"host": "shop.example.com",
			"path": "/shop",
			"queue_all": true,
			"new_users_per_minute": 200,
			"total_active_users": 300,
			"session_duration": 1,
			"disable_session_renewal": false,
			"json_response_enabled": false,
			"queueing_method": "fifo",
			"queueing_status_code": 202,
			"cookie_attributes": {
				"samesite": "auto",
				"secure": "auto"
			}
		}
	]
}