API и webhooks

Запускайте создание карточек из своей системы — без ручного переноса данных

Создайте отдельный API-ключ для сайта, интернет-магазина или внутреннего сервиса. Отправляйте бриф и изображения, проверяйте статус задачи, скачивайте готовый PNG и получайте подписанное событие, когда генерация завершена или требует внимания.

API-ключ создаётся бесплатно. Каждая новая задача использует баланс аккаунта по обычным тарифам; технические внутренние повторы отдельно не списываются.
Идемпотентный запрос принят, событие о готовности подписано
Idempotency-KeyПовтор одного запроса не создаёт вторую задачу и повторное списание
Подписанные webhooksПроверяемое событие о готовности, ошибке или подтверждённой оплате
До 10 ключейОтдельный секрет для каждого сайта, сервиса или окружения
Когда пригодится

API нужен, когда ручной кабинет уже становится узким местом

Для одного товара удобнее обычная форма. Но при регулярном потоке карточек сотрудники начинают копировать названия, характеристики и изображения между системами, следить за вкладками и вручную забирать результаты. API оставляет данные в вашем процессе и превращает VauKart в управляемый этап конвейера.

01

Интернет-магазин или PIM

Передавайте название, площадку, роль слайда, стиль и исходники из карточки товара. После готовности сохраните результат рядом с остальными материалами без повторного ввода брифа.

02

Агентство и производство контента

Разделите ключи по клиентам, проектам или окружениям. Так проще отозвать один доступ, не останавливая остальные интеграции и не передавая главный пароль от аккаунта.

03

Внутренний кабинет команды

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

Что умеет VauKart

Минимальный набор, достаточный для боевой интеграции

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

Создание и проверка статуса

POST-запрос запускает инфографику, а отдельный GET возвращает состояние задачи. Приложение не обязано держать соединение открытым и может продолжить работу после перезапуска.

Проект и готовый файл

После завершения получите данные проекта и загрузите PNG через защищённый медиа-метод. Файл не публикуется по открытому адресу и требует действующий API-ключ.

События вместо постоянного опроса

Подключите webhook для generation.completed, generation.failed и payment.succeeded. VauKart подписывает доставку и повторяет временные ошибки до шести раз.

Понятный процесс

Интеграция без скрытых шагов

В кабинете есть пример запроса и список доступных методов. Полный секрет API показывается при создании, поэтому его нужно сразу сохранить в защищённом хранилище вашего сервера.

  1. 1

    Создайте отдельный ключ

    Назовите ключ по системе или окружению: например, «интернет-магазин production». Секрет не следует помещать в браузерный JavaScript, мобильное приложение, чат или публичный репозиторий.

  2. 2

    Отправьте одну задачу

    Передайте бриф, площадку, цель слайда и исходные изображения. Добавьте уникальный Idempotency-Key, связанный с товаром и версией результата.

  3. 3

    Получите состояние

    Проверяйте генерацию по идентификатору либо подключите webhook. Временная ошибка доставки не меняет сам результат и будет повторена по очереди.

  4. 4

    Скачайте и проверьте

    Заберите готовый PNG с авторизацией, сохраните его в своей системе и выполните те же проверки товара, текста и характеристик, что при работе через кабинет.

Внутри сервиса

Безопасность, списания и восстановление после ошибок

Автоматизация не должна создавать дубли и раскрывать секреты. Поэтому VauKart разделяет ключи, использует идемпотентность для создания задачи и подписывает исходящие события.

Управляемый доступ

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

Защита от повторного списания

Повтор запроса с тем же Idempotency-Key возвращает уже созданную задачу. Новая генерация появляется только с новым ключом идемпотентности и при достаточном балансе.

Подпись и повтор webhook

У каждого endpoint есть секрет подписи. При временной недоступности вашего сервера доставка повторяется; получатель должен проверять подпись и безопасно обрабатывать повтор одного события.

Практическая настройка

Как подготовить интеграцию к реальной нагрузке

Рабочий API-сценарий должен учитывать не только успешный ответ. Продумайте повтор запроса, очередь, недостаточный баланс, техническую ошибку и ручную проверку готового файла до того, как подключать весь каталог.

01

Свяжите ключ идемпотентности с бизнес-задачей

Формируйте Idempotency-Key из идентификатора товара, роли слайда и версии брифа, а не из текущего времени. Тогда повтор после таймаута безопасно вернёт уже созданную задачу. Когда сотрудник действительно меняет исходник или требования и нужен новый результат, увеличьте версию — это будет осознанный новый запуск и новое списание.

02

Храните состояние у себя

Сразу сохраните идентификатор генерации рядом с товаром или заказом. Не полагайтесь только на webhook: событие может прийти позже, повториться или временно не доставиться. Периодическая сверка незавершённых задач через GET помогает восстановиться после перезапуска вашего сервиса и не оставлять работу в неопределённом состоянии.

03

Разделите автоматизацию и публикацию

Готовый статус означает, что файл создан, но не подтверждает правильность характеристик и соответствие правилам площадки. Поместите результат в очередь проверки: сравните товар с исходником, прочитайте текст, проверьте маркировку и только затем передавайте изображение в CMS, PIM или маркетплейс. Для рискованных категорий оставьте обязательное ручное согласование.

04

Проверьте сбои до запуска каталога

На тестовом товаре воспроизведите повтор POST-запроса, временный недоступный webhook, отозванный API-ключ и пустой баланс. Убедитесь, что ваша система показывает понятный статус, не создаёт бесконечные повторы и позволяет сотруднику безопасно возобновить задачу. Такой короткий прогон дешевле исправления дублей после массового запуска.

Перед рабочим запуском

Что стоит проверить

  • API-секрет хранится только на сервере
  • Для каждого запуска задан устойчивый Idempotency-Key
  • Webhook проверяет подпись до обработки события
  • Готовое изображение проходит проверку товара и текста
Перед подключением

Короткие ответы без технического тумана

Сколько стоит доступ к API?

Создание ключей и webhook не списывает генерации. Баланс используется при запуске новой задачи по тем же правилам и тарифам, что в кабинете.

Как избежать повторного списания при сетевой ошибке?

Передавайте устойчивый Idempotency-Key. Повтор того же запроса с тем же ключом не создаёт вторую генерацию и возвращает существующую задачу.

Где хранить API-ключ?

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

Что умеют webhooks?

Можно получать события о готовой генерации, технической ошибке и подтверждённой оплате. Каждая доставка подписана, а временные сбои повторяются до шести раз.

API и webhooks

Сначала проверьте один запрос, затем подключайте поток

Создайте отдельный ключ, повторите пример из кабинета и убедитесь, что ваша система сохраняет идентификатор задачи, проверяет подпись webhook и не публикует секреты.

Открыть доступ к API