Для AI-агентов: markdown этой страницы — /docs-content/entities/documents/public-url.md индекс документации — /llms.txt

Включить или выключить публичную ссылку документа

POST /v1/documents/:id/public-url

Включает или выключает публичную ссылку, по которой документ приложения открывается в браузере без API-ключа и без входа в Битрикс24.

Параметры

Параметр Тип Обяз. Описание
id (path) number да Идентификатор документа, положительное целое число. Список: GET /v1/documents

Поля запроса (body)

Поле Тип Обяз. Описание
enabled boolean да true — включить ссылку, false — выключить. Строка "true" отклоняется

Примеры

curl — личный ключ

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/documents/2001/public-url" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled": true}'

curl — OAuth-приложение

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/documents/2001/public-url" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"enabled": true}'

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/documents/2001/public-url', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ enabled: true }),
})

const { success, data } = await res.json()
console.log('Ссылка:', data.publicUrl)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/documents/2001/public-url', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ enabled: true }),
})

const { success, data } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.publicUrl string | null Публичная ссылка на документ после enabled: true. null после enabled: false

Пример ответа

Ссылка включена:

JSON 
{
  "success": true,
  "data": {
    "publicUrl": "https://example.bitrix24.ru/~FbdN8"
  }
}

Ссылка выключена:

JSON 
{
  "success": true,
  "data": {
    "publicUrl": null
  }
}

Пример ответа при ошибке

400 — enabled не передан или не логическое значение:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FIELDS",
    "message": "enabled must be a boolean."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS id не положительное целое число. Сообщение: Document ID must be a positive integer.
400 MISSING_REQUIRED_FIELDS enabled не передан или не логическое значение, например "true"
404 ENTITY_NOT_FOUND Документа с таким id нет. Сообщение: Document not found.
502 BITRIX_INVALID_RESPONSE Битрикс24 ответил без состояния ссылки
422 BITRIX_ERROR Битрикс24 отклонил запрос. Текст причины — в error.message
403 BITRIX_ACCESS_DENIED Битрикс24 отказал в доступе к документу
403 WRITE_BLOCKED_READONLY_KEY Ключ работает в режиме только для чтения
403 SCOPE_DENIED Ключу не хватает скоупа documentgenerator
401 MISSING_API_KEY Не передан заголовок X-Api-Key
401 TOKEN_MISSING Ключу не сопоставлены токены — ключ OAuth-приложения вызван без пользовательской сессии

Полный список общих ошибок API — Ошибки.

Известные особенности

Документ по ссылке открывает любой, у кого есть адрес. Выключайте ссылку, когда доступ больше не нужен: после enabled: false прежняя ссылка в браузере отвечает 404.

Новое включение — новый адрес. Повторный enabled: true при уже включённой ссылке возвращает тот же адрес. После выключения следующее включение выдаёт другой адрес.

Смотрите также