Chaves de API

Qual a sua dúvida?

• Por que usar Chaves de API
• Casos de utilização
• Passo a passo para a configuração
• Informações importantes
• Segurança da Chave de API

Na API 2.0 de integração, o RD Station Marketing trabalha com o protocolo OAuth durante o processo de autenticação e autorização às informações da conta do usuário.

Agora, além da autenticação via OAuth, o RD Station Marketing também suporta a autenticação via Chaves de API (API Keys, em inglês).

Por que usar Chaves de API

As APIs 1.2 e 1.3 são modelos de autenticação simples, quando comparado com o OAuth. Porém, com a API 2.0, além de recursos novos, você também poderá utilizar as Chaves de API.

As chaves de API não são tão seguras quanto a autenticação via OAuth, mas elas ajudam a identificar o aplicativo ou projeto que está chamando uma API de uma forma mais simples.

As integrações de formulário, por exemplo, contam com os recursos das APIs 1.2 e 1.3, e com a utilização das Chaves de API, você passará a ter total controle na criação, ativação e desativação dos tokens. 

Casos de utilização

• Integrações de formulário de conversão;
• Sistemas internos que enviam conversões para o RD Station Marketing.

Passo a passo para a configuração

1. Acesse a App Store do RD Station Marketing;
2. Faça o login na página de gerenciamento e clique em Gerar Chave;
3. No menu superior direito, clique em Gerar Chave de API;
4. O sistema automaticamente irá exibir a Chave criada na listagem;
5. Defina um nome para a Chave. Isso irá te auxiliar na hora de gerenciar e localizar as Chaves;
6. Escolha se a Chave criada ficará ativa ou inativa clicando no botão de Situação;
7. Copie o código da Chave e cole no script do formulário que irá utilizar para integrações de conversões com RD Station Marketing.

Informações importantes

1. A Chave de API suporta apenas eventos de conversão;
2. Você poderá criar até 5 Chaves;
3. Não é possível realizar a exclusão de Chaves, permitimos somente ativação e desativação;
4. Não é necessário a implementação do protocolo OAuth para a utilização das Chaves de API;
5. O usuário do RD Station Marketing precisa ter o perfil de acesso de Gestor ou Dono para acessar a tela de gerenciamento de Chaves da API. 

Segurança da Chave de API

As Chaves de API concedem acesso total à sua conta do RD Station Marketing e devem ser protegidas da mesma forma que uma senha. Existem alguns cenários comuns que devem ser levados em conta ao trabalhar com Chaves de API, veja cada uma delas abaixo:

• Cada integração deve ter a própria Chave de API

 Nomeie cada Chave corretamente, para saber qual delas funciona com cada aplicativo. Se uma Chave de API específica for comprometida, você poderá desativá-la sem desativar o acesso às demais integrações.

• Não exponha suas Chaves ao público 

Tenha cuidado para que suas Chaves não sejam expostas em capturas de tela, vídeos ou documentação de ajuda. Vale lembrar que desfocar os dados em uma imagem nem sempre é o suficiente, o melhor é recortar parte da imagem removendo completamente os dados.

• Compartilhamento de Chave

Caso seja necessário compartilhar uma Chave, nossa recomendação é que você gere uma nova Chave e rotule-a de forma correspondente para poder desativá-la, se necessário. Nunca envie a Chave de API por email, pois, caso a conta de email seja invadida por hackers, eles poderão enviar conversões para a conta do RD Station Marketing.

• Acesso a lista de Chaves

O acesso à lista de Chaves é determinado pela função da pessoa usuária que gerou a Chave de API. Para saber mais sobre as permissões e perfil de cada usuário, acesse suas configurações.