Vizen API: 15-minute quickstart
/docs/quickstartcurrentМашинный перевод с английского· проверено 2026-10-25
Статус: current · проверенный: 2026-10-25, проверенный по паспорту, product-обработчик списка и request/response schema; нет live используемые учетные данные владелец: гладиатр API документация · Служить: GET /docs/quickstart
1. Минута 0-5: получить key
Следуйте за мной. аутентификация: key и разрешения выдать а key в shop и поставлять его безопасно в ваш процесс как VIZEN_TOKEN. Это document Владеет выпуском, secret обработки, разрешения и contour правила. Примеры использования Bash, curl и jq. API base: https://api.vizen.shop.
Используйте приведенные ниже примеры с трассировкой оболочки и HTTP header инвалид. Никогда не вставляй key вводить source code, HTML, Отчет или чат message.
2. Минуты 5-8: читать key's паспорт
Сделай это своим first аутентифицированный запрос:
PASSPORT=$(curl --fail-with-body -sS https://api.vizen.shop/v1/account/token \
-H "Authorization: Bearer $VIZEN_TOKEN")
printf '%s\n' "$PASSPORT" | jq .
VIZEN_COMPANY_ID=$(printf '%s\n' "$PASSPORT" | jq -er '.company_id')Читайте фактическое scopes, capabilities, contour и warnings before выбор Операция. генерируемый scope ссылка список current права. Использовать store.storefront_url для shop address. Предустановленный name это Не доказывайте, что есть доступ. паспорт field руководство Смысл каждого из них field Что делать, если отсутствует доступ.
проверять: паспорт успешно выдается и определяет предполагаемое shop и рабочий процесс. Если он не сработает или неправильно назовет shop, Остановитесь здесь и следуйте за аутентификацией Путеводитель: не test Доступ к нему путем создания product. Этот быстрый старт не делает никаких записей.
3. Минуты 8-10: сделать сейф first GET
Прочитайте одну запись в каталоге, ничего не меняя.:
curl --fail-with-body -sS \
"https://api.vizen.shop/products?page.number=1&page.limit=1&filter.company_id=$VIZEN_COMPANY_ID" \
-H "Authorization: Bearer $VIZEN_TOKEN"проверять: проверять result.items и result.total в JSON ответ. Ан empty shop может return ан empty Список; никаких приспособлений не должно быть created. The shop id Выдается из паспорта, выбирается shop без предоставления Оба параметра пагинации предоставляются намеренно; каталог API использование /products, без /v1. Читать Каталог для фильтрации и метод schema before Расширение запроса.
А. 200 на этот счет public конечная точка каталога не доказывает частный доступ: может return анонимный view. Паспорт с этапа 2 - это аутентификация. Для папки-связанной или иным образом ограниченной key, continue Только вдоль рабочий процесс позволяет паспорт; это GET не расширяет свои полномочия.
4. Минуты 10-15: выберите руководство для своей задачи
| Ваша задача | Продолжайте здесь | Что проверить дальше |
|---|---|---|
| создавать products и загружать фотографии; import каталог | Каталог import, В том числе и product-и-photo Рецепт в §7.3 | Перечитывайте created объект и его галерея before публикация. |
| Построить многоразовое семейство-card компонент | семья-card учебный | Проверьте две вставки и откат path. |
| Переместить существующий site или template | Передача сайта | Следуйте за его предполетным и draft принятие steps. |
| Построить shop page с твоим own HTML/CSS/JS | Кодирование Web | Выберите поддерживаемую разметку level и проверить сделанный page. |
| Конфигурация платформы blocks | Виджеты (проза)) | Перечитывать вложенные props; консультации виджеты schema (JSON) для exact kind. |
| собирать form представления | Формы и leads | Проверить forms разрешения отдельно от доступа к представленным свинцам data. |
Прочитайте одно руководство по задачам, затем только ссылку sections Это необходимо. Создание продукта., photo загрузка и партия-import инструкция live в Каталог import; В этом быстром запуске нет второго экземпляра. Следуйте инструкциям по заданиям.'s проверка before Публикация или отчетность о result в owner.
Найти другие задачи в документация index. Агенты могут использовать Карта чтения и Мастерство входа. Использование ошибок устранение неполадок; для recent Изменения в использовании Изменить.