Chaves

Após concluir a contratação, abra o menu “Gerencial” e selecione o item API ABERTA"

CRIANDO UMA NOVA CHAVE

Defina sua primeira chave de integração, passando por estas opções:

  • Nome: Defina como deseja identificar sua chave
  • Tipo: Disponível apenas para a unidade matriz de uma rede. Escolha se os dados serão obtidos apenas da unidade logada (integração avulsa) ou de todas as unidades da rede (integração multiempresa).
  • Permissões: Selecione quais consultas essa chave poderá executar. Recomendamos manter sempre o MÍNIMO de permissões necessárias para uso.

Por fim, clique em "Cadastrar"

API_KEY e API_SECRET

Após cadastrar a chave, você receberá as credenciais de acesso, compostas por duas partes:

  • Chave pública (API_KEY)
    • Essa chave tem um nível de acesso menor do que o da chave privada. Ela também serve como uma forma de autenticação, mas você pode usá-la apenas em operações como encriptação de dados. Exemplo de chave pública: pk_tfSR6ZbtBtMeWfMZX3
  • Chave privada (API_SECRET)
    • Essa chave é a mais importante, pois ela funciona como uma forma de autenticação intransferível para a sua empresa. É extremamente importante que você mantenha essa chave segura, dada a sua sensibilidade. Exemplo de chave secreta: sk_tfwsqAH8XgwKe9nPAqfIgS1
❗️

Chave de Casa

Pense que suas chaves de api, são as chaves de sua casa. Você compartilharia a chave de sua casa com qualquer um? Mantenha suas chaves de api em sigilo, e não compartilhe com ninguém, são dados sensíveis aos quais apenas você deve ter acesso.

🚧

Atenção: as chaves de acesso podem ser visualizadas apenas uma única vez.

EDIÇÃO DAS CHAVES

Você pode alterar o status da chave entre “Ativo” e “Inativo” sempre que necessário. Caso não utilize mais determinada chave, recomenda-se inativá-la..