RealityConnect API FAQ
Algumas perguntas não pertencem a nenhuma página de referência específica. São comerciais, arquiteturais, ou tratam do que a API não faz. Esta página reúne as que mais aparecem em conversas de suporte, engenharia de soluções e vendas, antes mesmo de uma linha de código ser escrita.
Posso acessar mais de uma organização com um único conjunto de credenciais?
Seção intitulada “Posso acessar mais de uma organização com um único conjunto de credenciais?”Não, por design. Cada token OAuth fica permanentemente vinculado à organização para a qual foi emitido, e não há como alternar ou ler entre organizações com um único conjunto de credenciais. Veja a Introdução e a Visão geral de capacidades para o panorama completo do que a API pode e não pode fazer.
Por que minha lista aparece vazia mesmo com todos os escopos no meu token?
Seção intitulada “Por que minha lista aparece vazia mesmo com todos os escopos no meu token?”Verifique o acesso ao conteúdo e a função, não os escopos. Os escopos OAuth são apenas a camada 1 do modelo de segurança, então um token com todos os escopos ainda enxerga apenas os nós aos quais a conta chamadora tem acesso ao conteúdo, e só pode agir dentro da função atribuída a ela ali. Um resultado vazio quase sempre indica um problema na camada 2 ou 3, não um escopo faltando. Escopos OAuth por tarefa confirma se você ao menos tem os escopos corretos; a partir daí, verifique o acesso ao conteúdo e a função da conta chamadora naquele nó.
Como encontro a região da minha organização?
Seção intitulada “Como encontro a região da minha organização?”Chame GET /oauth/api-info com seu token de acesso. A resposta inclui sua apiUrl regional e seu organization.id. Nunca fixe uma URL regional no código. Veja Primeiros passos e o Fluxo Client Credentials para um exemplo completo.
Posso usar a API sem uma licença do RealityTwin ou um assento do RealityPlan?
Seção intitulada “Posso usar a API sem uma licença do RealityTwin ou um assento do RealityPlan?”Para a maior parte, sim. Uma licença do RealityTwin Data Manager só é consumida por chamadas que envolvem conteúdo de um twin (ativos, POIs, zonas, rascunhos, busca, metadados de objetos, sessões de embed e a biblioteca de ativos). O gerenciamento de usuários e convites, as funções e a chamada de descoberta /oauth/api-info não envolvem nenhum twin e não consomem licença. Alguns endpoints relacionados ao RealityPlan também consomem um assento do RealityPlan. Veja Licenciamento.
Existe um ambiente de teste ou sandbox?
Seção intitulada “Existe um ambiente de teste ou sandbox?”Hoje não existe um ambiente de sandbox ou teste dedicado. A forma mais simples de testar a API é criar um aplicativo Client Credentials na sua própria organização. Veja Escolha um fluxo OAuth.
Como mantenho os identificadores do meu sistema nos objetos do Prevu3D?
Seção intitulada “Como mantenho os identificadores do meu sistema nos objetos do Prevu3D?”Não existe um campo reservado para isso. Use uma propriedade simples do tipo texto ou número nos metadados do objeto, por exemplo uma seção chamada “External IDs” contendo o identificador do seu sistema. Metadados são dados livres de chave/valor, não um esquema fixo, então qualquer nome de propriedade funciona sem provisionar nada antes. Veja Valores de metadados tipados e anexos.
Próximos passos
Seção intitulada “Próximos passos”- Visão geral de capacidades para o que a API consegue ler, escrever e o que ela simplesmente não faz.
- Primeiros passos para o modelo de segurança, o licenciamento e a escolha de um fluxo OAuth.
- Explore a referência da API para o catálogo completo de endpoints.