Preparar um identificador Box
01Em resumo #sec_d80f63df
REVIEWIT coleta uma empresa Box através de uma aplicação Box que você cria na consola de desenvolvimento da Box, em modo Server Authentication (Client Credentials Grant). Você confia a REVIEWIT três valores: o Enterprise ID, o Client ID e o Client Secret desta aplicação. REVIEWIT então obtém o token da conta de serviço da aplicação, válido por uma hora, e apenas lê.
Box não oferece uma área « leitura-only » para administração: as áreas Manage users ou Manage groups também permitem escrita, e a opção as-user permite agir em nome de um utilizador. REVIEWIT faz uso apenas em leitura: cada chamada que tem o direito de fazer está escrita no contrato do recurso, e nada mais é enviado.
021. Criar a aplicação #sec_02ac4128
Na Box Developer Console (app.box.com/developers/console), com uma conta da sua empresa:
- Create Platform App › Custom App;
- método de autenticação Server Authentication (Client Credentials Grant);
- nomeie-a, por exemplo REVIEWIT Collector.
Para ver o Client Secret, a verificação em duas etapas deve estar ativada na conta de desenvolvimento.
032. Configurar a aplicação #sec_9b48a95f
Separador Configuração:
- App Access Level: App + Enterprise Access. Sem ele, a aplicação não vê nenhum utilizador da empresa, e REVIEWIT recusa a ligação.
- Application Scopes, a marcar de acordo com os recursos que deseja coletar:
| Área | O que ela abre para REVIEWIT |
|---|---|
| Read all files and folders stored in Box | Pastas partilhadas, colaborações, ligações partilhadas, hubs |
| Manage users | Utilizadores geridos, administradores, colaboradores externos, utilizadores de aplicação |
| Manage groups | Grupos, membros, administradores de grupo |
| Manage enterprise properties | Diário de administração (última ligação), domínios autorizados, barreiras de informação, ligações Slack e Teams, hubs da empresa |
| Manage retention policies | Políticas de retenção (Box Governance) |
| Manage legal holds | Conservações legais (Box Governance; área sob pedido ao suporte Box) |
- Advanced Features: marque Make API calls using the as-user header. A conta de serviço vê apenas sua própria pasta: o conteúdo dos seus utilizadores é lido em seu nome, em leitura-only.
Uma área que você não marcar não bloqueia a ligação: os recursos que dependem dela permanecem simplesmente não coletáveis, e a etapa Preparar do assistente os nomeia. Um módulo que você não contratou (Box Governance, Box Shield) é lido como « não contratado », nunca « vazio ».
043. Fazer autorizar a aplicação por um administrador #sec_209c1692
Uma aplicação Client Credentials Grant só funciona autorizada na sua empresa:
- separador Authorization da aplicação › Review and Submit;
- um administrador Box: Admin Console › Platform › Platform Apps, a aplicação submetida › Authorize (ou Add com seu Client ID).
Qualquer modificação das áreas ou do acesso exige uma nova autorização (Platform Apps › … › Reauthorize): enquanto não for feita, Box aplica a configuração antiga.
054. Obter os três valores #sec_6b0a65ee
| Valor | Onde encontrá-la |
|---|---|
| Enterprise ID | Admin Console › Account & Billing › Account Information (um número) ; também no separador General Settings da aplicação |
| Client ID | Application › Configuration › OAuth 2.0 Credentials |
| Client Secret | Mesmo local ( Fetch Client Secret ) |
Em REVIEWIT : Conexões › Nova conexão › Box , introduza os três valores. A verificação :
- obtém o token da conta de serviço ;
- verifica se essa conta pertence à empresa introduzida ;
- verifica se vê os utilizadores da empresa ( App + Enterprise Access ).
Depois, a prova dos direitos constata cada âmbito por uma leitura mínima : Box não permite que uma aplicação liste os seus próprios âmbitos.
065. Se a conexão for recusada #sec_28cc585b
| Mensagem da Box | Causa | Ação |
|---|---|---|
| unauthorized_client | A aplicação não está autorizada na empresa | Secção 3 |
| invalid_grant / invalid_client | Secret errado ou regenerado, ou Enterprise ID que não é o da autorização | Recopiar o secret, verificar o Enterprise ID |
| The grant type is unauthorized | A aplicação não está em Client Credentials Grant | Criar uma aplicação Server Authentication (Client Credentials Grant) |
| the app reaches the enterprise but cannot list its users | App Access Only , ou âmbito Manage users ausente | Secção 2, depois reautorizar (secção 3) |
| insufficient_scope | Um âmbito falta | Assinalar o âmbito, depois reautorizar |
O secret só muda se o regenerar : faça-o a cada saída de uma pessoa que o viu, depois substitua-o em REVIEWIT.