Chave de Integração

O que é a chave de integração

A chave de integração é uma variável enviada nas chamadas de API que indica que quem está usando a API pode (ou não) usá-la. Esta chave também indica várias informações sobre quem está usando a API.

Essa chave é necessária para o uso das APIs e pode ser obtida de duas maneiras: através da API Login/Login (que será explicada na secção "Operacional" da documentação), ou através do portal (criando uma chave manualmente e usando-a nas chamadas).

Nesta secção ensinaremos como criar sua chave via portal.

---

Criando uma chave

Para criar uma chave de integração, após o cadastro completo e a habilitação de funções do usuário por um administrador do sistema, basta seguir os passos abaixo:

Primeiro clique no menu à direita (clicando no nome do usuário). Em seguida, no menu lateral clique em "Integrações/Config.".

Em seguida, vá na aba "Chaves de integração" e clique em "Nova Chave".

Na tela que aparecerá, sua chave será criada. Dê um nome a ela (o nome que desejar, apenas para seu controle, ele não será usado em local nenhum) e selecione a data de expiração. Já que, normalmente, os usuários continuam usando suas chaves sem desejar que expirem, recomendamos deixar este campo vazio, fazendo assim com que a chave não expire.

Com isto feito, basta clicar em salvar e a chave será gerada.

Pronto. A chave de integração foi gerada e pode ser adquirida clicando no botão à direita na tabela para pegar seu valor. Este valor será substituído no parâmetro "key" das chamadas (que nesta documentação estão mascarados com o valor "{{Key}}").