Pular para o conteúdo principal
A API do GetQR está em beta e disponível para workspaces selecionados. Os detalhes podem mudar antes do lançamento oficial.
A API do GetQR autentica cada requisição com a chave de API da sua conta. Cada usuário tem uma chave, e ela age em seu nome em um workspace.

​
Antes de começar

  • Você é o proprietário do workspace ou um Editor. Viewers não podem criar nem usar uma chave de API.
  • O proprietário do workspace tem uma assinatura ativa.

​
Crie sua chave de API

1

Abra as configurações da conta

Abra as configurações da sua conta e vá para API.
2

Gere a chave

Clique em Generate API key.
3

Copie a chave

Exiba a chave e copie-a. As chaves começam com sk_live_.
Você pode exibir e copiar a chave de novo a qualquer momento. As configurações também mostram quando a chave foi criada e quando foi usada pela última vez.

​
Autentique as requisições

Envie a chave como token Bearer no cabeçalho Authorization de todas as requisições:
A verificação de status é o único endpoint que funciona sem chave.

​
Acesso e funções

  • Funções. Somente o proprietário do workspace e os Editors podem criar e usar uma chave de API. Viewers não podem.
  • Workspace. Cada chave pertence a um único workspace, e toda requisição é executada nesse workspace. Você não precisa informar um ID de workspace.
  • Verificação contínua. O acesso é verificado a cada requisição com base na sua função atual e na assinatura do proprietário do workspace. A sua própria assinatura não conta. Se sua função mudar para Viewer ou a assinatura do proprietário terminar, as requisições retornam 403 até o acesso ser restabelecido. Você não precisa de uma nova chave.
  • Remoção. Se você for removido do workspace, sua chave de API é excluída. Se for adicionado de novo, gere uma nova chave.

​
Regenere sua chave

Regenere a chave se ela vazar ou se alguém que não deveria tê-la conseguir acesso.
Sua chave atual para de funcionar na hora. Qualquer app ou integração que a use deixa de funcionar até você atualizá-lo com a nova chave.
1

Clique em Regenerate

Nas configurações da conta, vá para API e clique em Regenerate.
2

Confirme

Clique em Regenerate key.
3

Atualize seus apps

Copie a nova chave e substitua a antiga em todos os lugares onde você a usa.

​
Mantenha sua chave segura

Trate a chave como uma senha: qualquer pessoa que a tenha pode criar, alterar e excluir QR codes no seu workspace.
  • Guarde-a em uma variável de ambiente ou em um gerenciador de segredos, não no código-fonte.
  • Chame a API apenas a partir do seu servidor. Nunca coloque a chave em um site, app móvel ou qualquer outro lugar que os usuários possam inspecionar.
  • Compartilhe-a apenas com os desenvolvedores que precisam dela.
  • Regenere-a assim que suspeitar de um vazamento.

​
Problemas comuns

A chave foi regenerada, ou você foi removido do workspace e a chave foi excluída. Copie a chave atual nas configurações da conta ou gere uma nova.
Verifique se sua função é proprietário ou Editor e se a assinatura do proprietário do workspace está ativa. A chave volta a funcionar assim que o acesso for restabelecido.
A API está em beta e ainda não está habilitada para o seu workspace.
Elas aparecem apenas para o proprietário do workspace e os Editors, e só em workspaces onde a API está habilitada.

​
Próximos passos

Introdução à API

Erros