Introdução
A RealityConnect API é a única superfície pública que permite a sistemas externos interagir com o ecossistema da Prevu3D. Use-a para ler e gravar conteúdo no RealityPlatform, controlar espaços de trabalho do RealityTwin, gerenciar sua organização, enviar arquivos e conjuntos de dados e muito mais.
Como a API está organizada
Seção intitulada “Como a API está organizada”Vale conhecer algumas decisões de design antes de começar a desenvolver:
- URLs base regionais. A API é executada em várias regiões (Leste dos EUA, Centro da Europa, Norte da Ásia, Centro do Canadá). Sua organização é provisionada em exatamente uma delas. Sempre obtenha sua URL base no endpoint de descoberta em vez de codificá-la de forma fixa. O guia Primeiros passos mostra como.
- Tudo tem escopo na sua organização. Um token só enxerga os nós aos quais o usuário de serviço recebeu acesso. Chamadas entre organizações não são possíveis.
- Os recursos vivem em uma hierarquia de conteúdo. A maioria das operações tem como alvo um nó identificado por UUID. Os nós formam uma árvore (organização → divisão → site → pasta → ativo) que você pode navegar com o endpoint
/nodes/{id}/browse. - Controle de acesso em três camadas. Escopos OAuth, acesso ao conteúdo e funções por nó precisam ser aprovados para que uma requisição seja bem-sucedida. Consulte o Modelo de segurança para saber como configurar cada um.
- JSON por HTTPS. Cada endpoint aceita e retorna JSON, usa autenticação por token bearer e segue os códigos de status HTTP padrão.
Autenticação OAuth
Seção intitulada “Autenticação OAuth”A autenticação da API é baseada no protocolo OAuth2. Fluxos suportados:
| Fluxo OAuth | Descrição | Exemplos de casos de uso |
|---|---|---|
| Client Credentials | Acesso servidor a servidor sem um usuário conectado. Cria um usuário de serviço na sua organização; você configura as permissões dele separadamente. | Scripts, automação, integrações de back-end, teste da API |
| Aplicativo nativo | Um usuário faz login pelo navegador e consente com os escopos. Usa Authorization Code + Native Application com PKCE e um redirecionamento http://localhost. Sem segredo de cliente. | Aplicativos de desktop, ferramentas de CLI, plugins de CAD |
| Authorization Code + redirecionamento HTTPS personalizado | Aplicativos web com uma URL de callback no seu próprio domínio. Usa Authorization Code com PKCE e uma URI de redirecionamento HTTPS de correspondência exata. | Aplicativos web, integrações SaaS |
Próximos passos
Seção intitulada “Próximos passos”- Primeiros passos: pré-requisitos, acesso de rede, modelo de segurança e escolha de um fluxo OAuth.
- Fluxo Client Credentials: configuração servidor a servidor, da criação do aplicativo OAuth até a primeira chamada à API.
- Fluxo de aplicativo nativo: login do usuário com PKCE e um redirecionamento localhost.
- Fluxo Authorization Code + redirecionamento personalizado: login em aplicativo web com PKCE e um callback HTTPS personalizado no seu domínio.
- Referência interativa da API: catálogo completo de endpoints com esquemas de requisição/resposta e um construtor de requisições integrado.
- Snippets de código: exemplos em Python para copiar e colar para operações comuns da API.
- Fluxos de trabalho de Data Bundle: criação de um data bundle, envio de dados, início do processamento, monitoramento do progresso e download dos arquivos de entrada.