vcity logo
ГлавнаяРешенияИсследовать
ДЛЯ РАЗРАБОТЧИКОВ

Создавайте на vcity

Публичный REST API, официальный CLI и TypeScript SDK. Запрашивайте организации, товары, события, заказы, бронирования и предложения — программно.

Установить CLI

Всё, что нужно для запуска

Современный API и инструменты для интеграции vcity в ваш стек.

REST API

Эндпоинты чтения для организаций, товаров, событий, заказов, бронирований и предложений. Версионирование на /api/v1. OpenAPI 3.1.

Bearer-аутентификация по API-ключам

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

Официальный TypeScript SDK

@vcityio/api-client — типизированные ответы, сгенерированные из спецификации OpenAPI. ESM, Node 20+ и современные браузеры.

vcity CLI

Аутентифицируйтесь через device flow, просматривайте список ваших организаций, переключайте контекст и просматривайте товары прямо из терминала.

Webhooks

Скоро

Реагируйте на события — заказы, RSVP, платежи — в собственных сервисах.

Проводник OpenAPI

Просматривайте все эндпоинты с примерами на /docs/api. Пробуйте запросы прямо со страницы.

Получите API-ключ за две минуты

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

  1. 1

    Создайте или выберите организацию

    Перейдите в админ-панель вашей организации.

  2. 2

    Откройте вкладку API Keys

    Находится в настройках администратора организации по адресу /orgs/<id>/admin/api-keys.

  3. 3

    Сгенерируйте и скопируйте

    Полный секрет показывается один раз — сохраните его в надёжном месте. Используйте его как Bearer token в заголовке Authorization.

Открыть мои организации →
Authorization header
Authorization: Bearer vck_live_xxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

Установите CLI

Установка одной командой. Авторизация через device flow — без паролей и копирования токенов.

Установить
curl -fsSL https://vcity.io/cli/install.sh | bash
Войти
vcity login
Выполнить команду
vcity orgs list

Работа с API

Используйте curl напрямую или официальный TypeScript SDK.

bash
curl https://vcity.io/api/v1/orgs/your-org/products \
  -H "Authorization: Bearer $VCITY_API_KEY" \
  -H "Content-Type: application/json"

Что вы можете создать

Всё, что связано с коммерцией, контентом или 3D-присутствием вашей организации.

Синхронизация склада

Переносите товары из вашей ERP или PIM в магазины vcity. Поддерживайте остатки и цены в актуальном состоянии.

Автоматизация мероприятий

Создавайте мероприятия, управляйте участниками и получайте аналитику в своих инструментах.

Кастомная оплата

Создавайте встроенные сценарии покупки на своём сайте с расчётами внутри vcity.

Headless 3D

Запускайте брендированные 3D-пространства по запросу и встраивайте их куда угодно.

Сценарии на webhook

Скоро

Запускайте уведомления в Slack, обновления CRM или отправку заказов при продаже или регистрации.

Внутренние инструменты

Скоро

Создавайте админ-панели на основе данных вашей организации без переделки интерфейса.

Open source на GitHub

CLI и TypeScript-клиент открыты и публикуются в npm.

@vcityio/cli в npm →@vcityio/api-client в npm →Смотреть на GitHub →

Начните разрабатывать

Бесплатно попробовать, без банковской карты. API — тот же движок, что и vcity.io.

Документация API →Установить CLI