Докиво Витрина · обновлено 6 августа 2026

Программный доступ: API Докиво Витрины

Прямой ответ

Программный доступ — это те же короткие ссылки и постоянные страницы, но без интерфейса: запросом из вашей программы. Работает по токену, который выпускается в кабинете; токен передаётся заголовком Authorization и в любой момент отзывается.

наведите камеру
QR этой страницы: откройте материал на телефоне или поделитесь им
01

Как работает

Токен выпускается в кабинете и показывается один раз: сервер хранит только его отпечаток. Запросы идут на адреса, начинающиеся с /api/v1/, тело и ответ — JSON. Всё, что создано по токену, сразу принадлежит вашему аккаунту и видно в кабинете.

02

Конкретный пример

Товароучётная программа при поступлении партии создаёт короткую ссылку на карточку товара и печатает её на этикетке. Через месяц карточка переезжает — программа меняет цель запросом, напечатанные этикетки продолжают работать.

03

Вход и результат

Токен доступа из кабинета и данные объекта: адрес цели для ссылки или содержимое для страницы.

Короткий адрес, постоянная страница и статистика — теми же числами, что показывает кабинет.

ограничение

Не больше 300 запросов в час на токен. Предел бесплатного доступа по страницам общий с интерфейсом: программный доступ — другой способ работы, а не обход ограничений. Короткие ссылки безлимитны и здесь.

Токен: выпуск, хранение, отзыв

Токен доступа — не то же самое, что вход в кабинет. Сессия браузера живёт в устройстве и гаснет при смене пароля; токен нужен программе на сервере и обязан это переживать. Поэтому он выпускается отдельно и отзывается отдельно.

При выпуске токен показывается ровно один раз. В базе остаётся только его отпечаток, поэтому «напомнить» токен сервис не может физически — утраченный отзывают и выпускают новый. Это то же правило, что и у кодов управления страницами.

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

Первые три шага
  1. Войдите в кабинет и выпустите токен в разделе программного доступа — сохраните его сразу.
  2. Проверьте связь: GET /api/v1/account с заголовком Authorization: Bearer <токен> вернёт ваш тариф и пределы.
  3. Создайте первую ссылку: POST /api/v1/short-links с телом {"targetUrl": "example.ru/akciya"}.

В ответе придут короткий адрес и код управления. Код нужен, чтобы править ссылку и без API — например с телефона на посадочной странице.

Какие запросы бывают

Адреса построены единообразно: список и создание живут на общем адресе, отдельный объект — на адресе с коротким кодом. Правка принимается методом PATCH, и отсутствующее поле означает «оставить как было»: скрипт, меняющий заголовок, не сотрёт текст страницы.

Адреса программного доступа
ЗапросЧто делаетЧто в теле
GET /api/v1/accountтариф, пределы и счётчики
GET /api/v1/short-linksсписок ваших коротких ссылок
POST /api/v1/short-linksсоздать короткую ссылкуtargetUrl, title
GET /api/v1/short-links/<код>ссылка и статистика переходов
PATCH /api/v1/short-links/<код>сменить цель или подписьtargetUrl, title
GET /api/v1/pagesсписок ваших постоянных страниц
POST /api/v1/pagesсоздать постоянную страницуpageType, title, textContent, links
GET /api/v1/pages/<код>страница, настройки и открытия
PATCH /api/v1/pages/<код>правка содержимого и настроеклюбые поля страницы

Как выглядят отказы

Ответ всегда JSON и всегда содержит поле ok. При отказе рядом лежат короткий код ошибки для программы и объяснение по-русски для человека, который будет читать журнал.

Отдельно стоит запомнить одно решение: чужой объект отвечает «не найдено», а не «нет доступа». Разница принципиальная — иначе перебором адресов можно было бы выяснить, какие ссылки существуют у других владельцев.

Коды отказов
КодКогда приходит
api_token_requiredтокена нет, он выдуман, отозван или аккаунт заблокирован
rate_limitedбольше 300 запросов в час на этот токен
invalid_target_urlцель ссылки не http(s) или это уже наш короткий адрес
page_limit_reachedисчерпан предел бесплатного доступа по страницам
short_link_not_foundссылки нет или она принадлежит другому аккаунту
qr_page_not_foundстраницы нет или она принадлежит другому аккаунту

Чего API не отдаёт — и почему

Статистика через API ровно та же, что в кабинете: число открытий и переходов, разбивка по дням и по источникам. Сведений о посетителях в ней нет, потому что их нет и в базе: переходы считаются без кук, без отпечатков браузера и без записи адреса перешедшего.

Это не пробел, который когда-нибудь заполнится «расширенной аналитикой». Обещание «считаем переходы, не людей» закреплено тестами сервиса, и программный доступ его не обходит: отдать через API то, чего не собираешь, невозможно.

Честные границы

Что сервис делает и чего не делает

  • Создавать и править короткие ссылки без интерфейса
  • Создавать и править постоянные QR-страницы
  • Читать статистику переходов и открытий по дням и источникам
  • Держать до десяти действующих токенов и отзывать любой
  • Показать, кто открывал страницу или переходил по ссылке — таких сведений сервис не собирает
  • Выдать чужие объекты: не ваш адрес отвечает «не найдено», а не «нет доступа»
  • Обойти предел бесплатного доступа по страницам
  • Вернуть утраченный токен — только отозвать и выпустить новый

Пошаговая инструкция

Порядок подключения

  1. Выпустите токен в кабинете и сохраните его
  2. Проверьте связь запросом GET /api/v1/account
  3. Создавайте ссылки и страницы запросами POST
  4. Читайте статистику запросом GET по адресу объекта
  5. Отзовите токен, если он больше не нужен или мог утечь

Перед печатью или публикацией

До боевого запуска

  • Токен хранится в переменной окружения, а не в коде
  • Программа готова к ответу rate_limited и повторяет запрос позже
  • Коды управления, пришедшие при создании, сохранены
  • Ненужные токены отозваны

Частые вопросы

Коротко о важном

5 вопросов
Нужен ли отдельный тариф для программного доступа?

Нет. Токен доступен любому аккаунту, пределы те же, что и в интерфейсе: страницы ограничены бесплатным доступом, короткие ссылки безлимитны.

Что будет с объектами, если отозвать токен?

Ничего: ссылки и страницы продолжат работать и останутся в кабинете. Токен — это ключ к управлению, а не владелец объектов.

Можно ли создавать через API витрины товаров?

Пока нет: программный доступ покрывает короткие ссылки и постоянные страницы. Витрины остаются в интерфейсе — обещать неготовое мы не будем.

Есть ли готовый коннектор для ИИ-ассистентов?

Пока нет. Коннектор MCP запланирован отдельным шагом после того, как API поработает у первых пользователей и перестанет меняться. Сейчас доступен обычный REST.

Сколько живёт токен?

Пока вы его не отзовёте. Срока годности у него нет — именно поэтому его стоит держать в переменной окружения и отзывать при любом подозрении на утечку.

Источники и проверка

Материал обновлён: 6 августа 2026 · Проверка источников выполняется по методике сервиса.