Chaves de API

As Chaves de API permitem que você conceda acesso de uma API à sua conta BMS. Isso facilitará o acompanhamento de suas métricas usando uma plataforma externa. Algumas APIs, como o Zapier, podem ser configuradas para criar Anúncios com base em arquivos do Google Drive. Quando se trata de APIs, há muito que podemos fazer, e cada API terá suas particularidades. No entanto, a integração dessas APIs com o console da BMS é semelhante. Este artigo visa ajudá-lo a realizar essa integração.

Gerenciando Chaves de API

As Chaves de API estão disponíveis na página de permissões. Para acessá-la, clique no nome da sua conta no canto superior direito, depois clique em Permissões e, no menu à esquerda, clique em Chaves de API.

Lista de Chaves de API

Criando uma Chave de API

É possível Criar Novas Chaves de API e também Vincular Chave de API Existente.

Criar nova Chave de API

1. Clique em para adicionar uma Chave de API.

2. Selecione Criar Chave de API e preencha as informações:

   

   Editor de Chaves de API

   • Nome: Defina um nome para sua Chave de API.

   • Tags: Defina tags para sua organização.

   • Políticas: Defina políticas de acesso que limitam a que esta Chave de API concede acesso. Clique em para adicionar suas políticas. Cada política tem um nome e uma descrição do acesso que ela concede. Você também pode criar a Chave de API sem selecionar uma política.

   

   Tela de Seleção de Políticas

   • Após selecionar todas as políticas necessárias, clique em para confirmar sua seleção.

3. Clique em para salvar sua Chave de API.

Vincular Chave de API Existente

Esta opção permite que você vincule uma Chave de API existente de outra conta BMS.

Ao vincular uma Chave de API existente, você concederá acesso à sua conta para os usuários da Chave de API vinculada. Use políticas para controlar o que pode ser feito através desta Chave de API.

1. Clique em para adicionar uma Chave de API.

2. Selecione Vincular Chave de API existente e preencha os detalhes:

   

   Vinculando uma API Existente

   • ID da Chave de API: Informe o ID da Chave de API que você deseja vincular.

   • Políticas: Defina políticas de acesso que limitam o que esta Chave de API concede acesso, clicando em para adicionar suas políticas. Cada política requer um nome e uma descrição do acesso que fornece. Ao vincular Chaves de API, pelo menos uma política deve ser selecionada.

   • Após selecionar todas as políticas necessárias, clique em para confirmar sua seleção.

3. Clique em para salvar sua Chave de API.

Aba Códigos de Acesso

Após criar a Chave de API, você precisa gerar um Código de Acesso antes de poder começar a usá-la. Se você selecionar uma Chave de API vinculada, esta aba permanecerá desabilitada, pois não há necessidade de criar um código de acesso. Nesses casos, você usará o Código de Acesso da API vinculada, que pode ser fornecido por seu criador.

Aba Códigos de Acesso

1. Selecione a Chave de API para a qual o código de acesso precisa ser criado.

2. Clique em para criar um código de acesso para a Chave de API selecionada.

   

   Aba Códigos de Acesso
3. Insira uma descrição para seu código de acesso.

4. Clique em para salvar seu código de acesso

5. Logo após salvar suas alterações, o segredo do código de acesso será exibido assim:

   

   Segredo do Código de Acesso
6. É possível copiar o segredo usando o botão de copiar, , ou baixá-lo em um arquivo .txt.

Você pode criar até 2 códigos de acesso por Chave de API. Cada código é válido por 365 dias. Aconselhamos fortemente que você crie um novo código algumas semanas antes que o código atual expire para garantir que os serviços que dependem desta Chave de API não parem.

Como Acessar a BMS via API

Para interagir com os serviços da BMS programaticamente, você precisa incluir o Código de Acesso gerado em suas requisições de API. Seu acesso será restrito às APIs específicas que sua chave de API está autorizada a usar. Você pode incluir o Código de Acesso em suas requisições usando um dos seguintes métodos:

• No Cabeçalho da Requisição: Copie o valor para o cabeçalho x-api-key. Para isso, use o botão . Isso evitará erros de digitação. Cole-o no cabeçalho de suas requisições.

  

  Acessando a BMS via API - Método via Cabeçalho da Requisição
• Na Query String: Adicione o Código de Acesso à URL como um parâmetro de consulta apiKey. Você também pode usar o botão de copiar para evitar erros de digitação.

  

  Acessando a BMS via API -Método Query String

Para uma lista completa das APIs da BMS disponíveis, por favor, consulte nossa documentação.

Editando Chaves de API e Códigos de Acesso

Todos os detalhes das Chaves de API estão disponíveis para edição clicando em na mesma linha da Chave de API que você deseja editar. Após fazer suas alterações, clique em para salvá-las.

Você também pode excluir uma Chave de API clicando em , e, em seguida, confirmando a ação em. Tenha cuidado - esta ação não pode ser desfeita. Lembre-se de que qualquer API que dependa da Chave de API excluída deixará de funcionar. Em relação aos Códigos de Acesso, você pode visualizar o segredo e baixar as credenciais clicando em na mesma linha do código de acesso. A descrição do código de acesso também pode ser editada clicando em . Quando terminar, clique em para salvar suas mudanças.

Atenção! Tenha cuidado ao excluir um código de acesso. Esta ação não pode ser desfeita, e todos os serviços que dependem deste código de acesso deixarão de funcionar.

Você também pode excluir códigos de acesso. Isso é útil em casos onde os dados possam ter sido comprometidos. Para fazer isso, primeiro desabilite o código movendo a chave seletora para a posição de desligado e, em seguida, clicando em na mesma linha do código de acesso que deseja excluir e confirmando em .