vcity logo
InícioSoluçõesExplorar
PARA DESENVOLVEDORES

Construa no Vcity

API REST pública, CLI oficial e SDK TypeScript. Consulte organizações, produtos, eventos, pedidos, reservas e orçamentos — de forma programática.

Instalar a CLI

Tudo o que você precisa para lançar

Uma API moderna e ferramentas para integrar o Vcity à sua stack.

API REST

Endpoints de leitura para organizações, produtos, eventos, pedidos, reservas e orçamentos. Versionados em /api/v1. OpenAPI 3.1.

Autenticação Bearer com chaves de API

Gere chaves por organização a partir do painel admin da sua organização. Escopo limitado a uma única organização. Rotacione ou revogue a qualquer momento.

SDK TypeScript oficial

@vcityio/api-client — respostas tipadas geradas a partir da especificação OpenAPI. ESM, Node 20+ e navegadores modernos.

CLI do Vcity

Autentique-se via device flow, liste suas organizações, alterne de contexto e navegue pelos produtos direto do seu terminal.

Webhooks

Em breve

Reaja a eventos — pedidos, confirmações, pagamentos — nos seus próprios serviços.

Explorador OpenAPI

Navegue por cada endpoint com exemplos em /docs/api. Teste requisições direto da página.

Obtenha sua chave de API em dois minutos

As chaves ficam no painel da sua organização. Cada chave tem escopo limitado a uma única organização e pode ser rotacionada ou revogada a qualquer momento.

  1. 1

    Crie ou escolha uma organização

    Acesse o painel de administração da sua organização.

  2. 2

    Abra a aba Chaves de API

    Disponível nas configurações de administração em /orgs/<id>/admin/api-keys.

  3. 3

    Gere e copie

    O segredo completo é exibido apenas uma vez — armazene-o com segurança. Use-o como Bearer token no header Authorization.

Abrir minhas orgs →
Authorization header
Authorization: Bearer vck_live_xxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

Instale a CLI

Instalação em uma linha. Autenticação via device flow — sem senhas, sem copiar tokens.

Instalar
curl -fsSL https://vcity.io/cli/install.sh | bash
Entrar
vcity login
Executar um comando
vcity orgs list

Converse com a API

Use curl diretamente ou o SDK oficial em TypeScript.

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

O que você pode construir

Qualquer coisa que envolva o comércio, conteúdo ou presença 3D da sua org.

Sincronizar estoque

Envie produtos do seu ERP ou PIM para as lojas vcity. Mantenha estoque e preços sempre alinhados.

Automatizar eventos

Crie eventos, gerencie participantes e extraia analytics a partir das suas próprias ferramentas.

Checkout personalizado

Construa fluxos de compra embarcados no seu site que são finalizados dentro da vcity.

3D headless

Crie espaços 3D com sua marca sob demanda e incorpore-os em qualquer lugar.

Fluxos baseados em webhooks

Em breve

Dispare alertas no Slack, atualizações no CRM ou fulfillment quando uma venda ou RSVP acontecer.

Ferramentas internas

Em breve

Crie dashboards administrativos sobre os dados da sua org sem precisar reconstruir a UI.

Open source no GitHub

Tanto a CLI quanto o cliente TypeScript são abertos e versionados via npm.

@vcityio/cli no npm →@vcityio/api-client no npm →Ver no GitHub →

Comece a construir

Grátis para testar, sem cartão de crédito. A API é o mesmo motor que faz a vcity.io funcionar.

Ler a documentação da API →Instalar a CLI