Защита флипбука паролем

Управление доступом

Включайте или выключайте защиту паролем для флипбука и настраивайте экран ввода пароля — заголовок, подсказку поля и кнопку — одним вызовом API.

API, используемые в этом обсуждении

PUTSet Password Access/api/set-password-access/{flipbookId}

Что-то в этом руководстве неточно или устарело?

Что можно сделать

Защита паролем ставит перед флипбуком заслон: зрители должны ввести правильный пароль, прежде чем загрузится содержимое. Одним вызовом API можно:

Включить защиту и задать пароль доступа.
Выключить защиту обратно.
Настроить экран ввода пароля — заголовок, подсказку в поле и надпись на кнопке.

Перед началом

Понадобится:

API-ключ — передаётся в заголовке X-Api-Key в каждом запросе.
flipbookId — числовой id, который возвращается при создании флипбука (как ID) или из эндпоинтов списка.
Запросы идут на базовый URL https://go.fliplink.me.

Тело запроса — form-urlencoded (не JSON).

Параметры

Передавайте их как urlencoded-поля в PUT /api/set-password-access/{flipbookId}:

Поле	Тип	Что делает
`IsPasswordProtected`	boolean	`true` включает пароль-заслон; `false` выключает его
`Password`	text	Пароль доступа, который должны ввести зрители
`PwdTitle`	text	Заголовок на экране ввода пароля (необязательно)
`PwdPlaceholder`	text	Текст-подсказка внутри поля пароля (необязательно)
`PwdButton`	text	Надпись на кнопке отправки (необязательно)

Включение защиты паролем

Задайте IsPasswordProtected=true и укажите Password. Три поля Pwd* необязательны — добавьте их, чтобы настроить то, что видит зритель.

curl -X PUT 'https://go.fliplink.me/api/set-password-access/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPasswordProtected=true' \
  --data-urlencode 'Password=spring-2026' \
  --data-urlencode 'PwdTitle=Enter the access code' \
  --data-urlencode 'PwdPlaceholder=Access code' \
  --data-urlencode 'PwdButton=View document'

Ответ:

{ "Result": "OK", "Message": "Updated successfully" }

Выключение защиты паролем

Задайте IsPasswordProtected=false. Остальные поля можно оставить пустыми.

curl -X PUT 'https://go.fliplink.me/api/set-password-access/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPasswordProtected=false' \
  --data-urlencode 'Password=' \
  --data-urlencode 'PwdTitle=' \
  --data-urlencode 'PwdPlaceholder=' \
  --data-urlencode 'PwdButton='

Ответ:

{ "Result": "OK", "Message": "Updated successfully" }

Настройка экрана ввода пароля

Поля PwdTitle, PwdPlaceholder и PwdButton позволяют подогнать заслон под вашу аудиторию — например, назвать его «кодом доступа» для клиентского портала или подстроить под тон вашего бренда. Они необязательны; опустите их (или отправьте пустыми), чтобы использовать значения по умолчанию.

Возможные ошибки

Отсутствующий или неверный API-ключ → HTTP 401. Возвращается обычная HTML-страница Unauthorized — тела JSON нет. Проверьте, что заголовок X-Api-Key присутствует и указан верно.
Неизвестный flipbookId (или не принадлежащий вашему ключу) → HTTP 200 с { "Result": "ERROR", "Message": "Item not found" }.
Опечатка в имени поля тела запроса → HTTP 200 с { "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }. Сверьте имена полей с таблицей выше.

Примечания

Передавайте пароль отдельным каналом. Отправляйте ссылку на флипбук и пароль по разным каналам — пароль, вложенный в то же письмо, что и ссылка, почти не защищает.
Защита паролем — это один слой. Она контролирует вход, а не то, кто зритель. Чтобы ограничить доступ названными людьми, сочетайте её со списком разрешённых адресов; чтобы ограничить доступ по времени, сочетайте её с истечением срока ссылки.