RealityConnect API (RCAPI)
Introdução Visão geral da RealityConnect API da Prevu3D: recursos, arquitetura regional, autenticação OAuth2 e como ela se encaixa nas integrações com o RealityPlatform e o RealityTwin.
Primeiros passos Pré-requisitos, acesso de rede e o modelo de segurança da RealityConnect API. Escolha um fluxo OAuth e siga o guia dedicado a ele.
Sua primeira mudança, do início ao fim Um percurso Client Credentials para copiar e colar: obtenha um token, navegue até um site, renomeie-o, veja a mudança na Prevu3D Platform e depois desfaça.
Referência de escopos OAuth Todos os escopos OAuth concedidos pela RealityConnect API, o que cada um autoriza e as pegadinhas que costumam atrapalhar novas integrações.
Pesquisando objetos de negócio e nós Pesquise dentro dos objetos de negócio e metadados de um twin, ou pesquise na hierarquia de nós da sua organização, através da API do RealityConnect.
Fluxos OAuth Fluxo Client Credentials, Fluxo de Aplicativo Nativo, Fluxo Authorization Code + Redirecionamento Personalizado
Limites de taxa Buckets de limite de taxa da RealityConnect API, cabeçalhos de resposta e como lidar com o 429 Too Many Requests.
Códigos de erro Referência dos códigos de erro nomeados retornados pelas operações da RealityConnect API, agrupados por endpoint, com o formato da resposta e como tratar cada um.
O que contextId aceita Quais tipos de id o parâmetro de caminho contextId aceita nas rotas de twin e RealityPlan da RealityConnect API, e por que um id válido pode retornar 404.
Ciclo de vida do token na prática Como armazenar em cache e renovar um token OAuth da RealityConnect API com segurança em uma integração de longa duração: TTLs reais por fluxo e o que invalida um token antecipadamente.
Gerenciamento de credenciais Como armazenar, rotacionar e revogar com segurança as credenciais OAuth da API RealityConnect, e o que um token de acesso vazado pode alcançar.
O que excluir realmente faz, por recurso Referência do que a exclusão de cada recurso da RealityConnect API faz: quais exclusões são recuperáveis, o que as bloqueia e o que acontece com as referências deixadas para trás.
Tipos de nó e hierarquia Os 10 tipos de nó da API RealityConnect, quais combinações pai/filho são válidas, quais tipos a API pode criar e a estrutura do DataNode.
Estabilidade, versionamento e descontinuação da API Como a RealityConnect API marca operações experimentais, o que conta como mudança disruptiva, e a política de descontinuação.
Referência de ícones de POI (textureId) O conjunto completo de valores válidos de textureId para criar um ponto de interesse (POI), e o que cada ícone realmente representa.
Encontrando seus IDs: organizações, nós e contexto Descubra o ID da sua organização, percorra a árvore de nós da API RealityConnect e qual ID (contextId, organizationId) cada família de rotas espera.
Referência: envio multipart compartilhado O padrão iniciar, enviar e finalizar compartilhado pelos endpoints de envio da RealityConnect API, incluindo a regra partNumber versus startIndex.
Valores de metadados tipados e anexos Referência dos valores de propriedades de metadados da API RealityConnect: a união string/número/booleano/objeto marcado, os tipos sentinela external-link e attachment, e o fluxo de envio, download e exclusão de anexos.
Miniaturas de nó Envie, recupere e remova a imagem de miniatura de um nó de dados, e como includeThumbnail e thumbnailSignedUrl se comportam em browse e search.
Requisitos de rede Requisitos de firewall, proxy, TLS e saída (egress) para acessar a RealityConnect API a partir de uma rede corporativa, além de uma sequência de diagnóstico de conectividade passo a passo.
RealityConnect API FAQ Respostas às perguntas comerciais, arquiteturais e do tipo 'posso fazer isso?' sobre a RealityConnect API, que surgem antes mesmo de um projeto ser aprovado.