Criar uma conta de serviço

Objetivo

Criar um conta de serviço usando a ferramenta Administrador da empresa.

Fundo

As contas de serviço permitem oferecer suporte a integrações que exigem o fluxo de concessão de credenciais do cliente, conforme definido no memorial descritivo do marco 2.0 do IETF. Nesse cenário, os aplicativos precisam de uma maneira para recuperar um token de acesso OAuth 2.0 fora do contexto de qualquer usuário específico do Procore. O OAuth 2.0 fornece o tipo de concessão de credenciais do cliente para essa finalidade. Uma client_id e uma client_secret exclusiva é gerada quando uma nova conta de serviço é criada. Para obter informações sobre como implementar o fluxo de concessão de credenciais do cliente em um aplicativo, consulte OAuth 2.0 Usando as credenciais do cliente em nosso Portal do desenvolvedor.

Coisas a considerar

Permissão de usuário necessária:
- Permissões de nível "Administrador" na ferramenta Administrador da empresa.
Considerações de acesso:
- Uma nova conta de serviço consiste em:
  - client_id. O identificador da conta de serviço.
  - client_secret. O segredo é um código gerado aleatoriamente que será usado pela conta de serviço. Ela só fica visível para você no momento da criação da conta. Talvez você queira observar a client_secret e salvá-la em um local seguro caso exija referência no futuro.
    Importante! Se você perder a client_secret, o Procore recomenda seguir as etapas abaixo para criar uma nova conta de serviço.
  - Novas contas de serviço são criadas sem permissões ("Nenhuma") por padrão. Para alterar essas permissões, consulte Configurar permissões da conta de serviço.
Considerações importantes do Diretório da empresa:
- Após criar um conta de serviço, o endereço de e-mail associado não poderá ser alterado no Diretório da empresa. Se você modificar o endereço de e-mail conta de serviço, a conta de serviço deixará de ser funcional.
- Não é possível adicionar o contato conta de serviço a mais de um Diretório da empresa (apenas o diretório no qual foi criado) ou então ele vai parar de funcionar.

Passos

Acesse a ferramenta Administrador de nível de empresa.
Em "Definições da empresa", clique em Contas de serviço.
Na página Contas de serviço, clique em +Novo.
Especifique um "Tipo de aplicativo". Se você for usar essa conta de serviço com um aplicativo específico do Marketplace, selecione a opção Marketplace e escolha o aplicativo adequado na lista suspensa. Caso contrário, selecione Personalizado.

Digite um nome para sua nova conta de serviço e clique em Criar. As client_id e client_secret para os conta de serviço são geradas e ficam disponíveis para uso na realização de chamadas para o endpoint de API Procore/oauth/token.
Configurar permissões da conta de serviço. Como o conta de serviço não tem permissões no nível de empresa quando ele for criado pela primeira vez, você precisa definir as permissões adequadas para o conta de serviço antes de usá-lo para acessar a API Procore.

Importante

Lembre-se de que, embora você possa gerar um token de acesso OAuth 2.0 usando um conta de serviço sem permissões ("Nenhum"), esse token não funcionará para fazer chamadas bem-sucedidas para o API Procore. Portanto, você precisa definir as permissões adequadas para o conta de serviço antes de usá-la para acessar a API Procore.