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).

Tipos de chaves

No ControlPay, existem dois tipos de chaves de integração que podem ser usadas: "Chaves de Sistema" e "Chaves de Pessoa".

Chaves de Sistema

Chaves de Sistema são tokens criados durante o login (API Login/Login). Essas chaves são voláteis, tendo duração de apenas (aproximadamente) um dia e expirando em seguida.

Recomendamos o uso destas chaves apenas para integrações que especificamente necessitem de chaves que expirem ou acessos esporádicos. Para a integração e uso do ControlPay, NÃO recomendamos o uso de chaves de sistema (e, por consequência, da API Login/Login) e sim o uso de chaves sem expiração (Chaves de Pessoa criadas sem expiração, mostradas a seguir).

Chaves de Pessoa

Chaves de Pessoa são tokens criados dentro do ControlPay para uso em chamadas de API. Estas chaves podem ou não ter expiração e ficam salvas atreladas ao perfil da pessoa que as criou.

Recomendamos o uso destas chaves (sem expiração) para a realização de integrações com as APIs.

Criando uma chave de Pessoa

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

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}}").