API da Conta da JetBrains
Com a API da conta da JetBrains, você pode gerenciar licenças automaticamente e recuperar dados de uso de licença da sua Conta da JetBrains.
Os métodos da API permitem que você obtenha informações de licença, atribua ou revogue licenças e mova-as entre as equipes. A função da sua Conta da JetBrains define seu nível de acesso aos métodos da API. Para obter mais informações, confira a referência da API.
Funções
Há três níveis de acesso à API, que refletem as funções que podem ser atribuídas a você na sua organização.
- Administradores da organização podem ativar e desativar a API, gerar e regerar tokens para si mesmos e revogar tokens de acesso de todos os usuários da organização, incluindo outros administradores.
- Administradores de equipe podem gerar, regerar e remover tokens de acesso para todos na sua equipe, incluindo outros administradores dessa equipe.
- Espectadores e Contatos principais podem gerar, regenerar e remover tokens de acesso para si mesmos. Tokens de acesso de Visualizador e de Contato Primário permitem acesso somente de leitura à API.
Como habilitar a API
Para habilitar a API, siga estas etapas.
- Faça login na sua conta da JetBrains com credenciais de administrador da organização.
Administradores de equipe não podem habilitar ou desabilitar a API. - No menu à esquerda, clique no nome da sua organização e clique em Administration.
-
Clique em Enable API.
Isso disponibilizará a API para todos os administradores da organização e da equipe, bem como para os espectadores e contatos principais. Todos os usuários com funções atribuídas poderão gerar tokens.
Como desabilitar a API
Para desabilitar a API, siga as etapas 1 e 2 acima e clique em Disable API.
Esse botão desabilita a API para todos os administradores, espectadores e contatos principais.
Como acessar os métodos da API
Para acessar os métodos, você precisa de dois parâmetros.
1. Seu código de cliente para o parâmetro X-Customer-Code
O código do cliente é um ID de organização exclusivo. Para saber qual é o seu código de cliente, acesse sua Conta da JetBrains e procure o número ao lado do nome da sua organização.
Transmita esse valor ao parâmetro X-Customer-Code.
2. Seu token de acesso para o parâmetro X-Api-Key
Para gerar o token de acesso:
- Acesse sua Conta da JetBrains.
- No menu à esquerda, clique no nome da sua organização ou equioe e clique em Administration.
- Clique em Generate Token.
- Aparecerá uma caixa de diálogo, que mostrará o token. Por motivos de segurança, você só verá essa caixa de diálogo uma vez. Salve o token em um local seguro antes de fechar a caixa de diálogo. Não compartilhe seu token com mais ninguém.
Se você perder o seu token, precisará gerar um novo. A geração de um novo token invalidará o anterior.
Transmita o token obtido para o parâmetro X-Api-Key.
Vida útil do token
Se você desabilitar e depois habilitar novamente a API, o seu token de acesso continuará o mesmo e ainda será válido, a menos que você gere um novo token manualmente.
Cada usuário tem exatamente um token, mesmo que esse usuário tenha várias funções atribuídas. O token permanece o mesmo enquanto o usuário mantém pelo menos uma função. Se um usuário perder todas as suas funções, seu token de acesso será automaticamente revogado.