Criar e gerir chaves API
Criar uma chave para a API pública, escolher os seus âmbitos e a sua expiração, restringi-la por endereço IP e depois revogá-la.
Uma chave API permite que as suas ferramentas chamem a API pública da Upsellr em nome da sua organização. O acesso à API está reservado ao plano Enterprise.
Onde encontrar as chaves
Abra o menu da conta e depois Manage e API & webhooks. Num plano que não seja o Enterprise, a secção mostra “Included in the Enterprise plan” e um botão para mudar de plano.
Criar uma chave
- Clique em Create API Key.
- Dê-lhe um Name que diga para que serve, por exemplo o nome da ferramenta que a utiliza.
- Escolha um Scope preset:
- Read only: ler os canais, produtos, fontes, workflows, membros e a organização.
- Read & Write: tudo, exceto lançar workflows.
- Full access: todos os âmbitos, incluindo lançar workflows.
- Custom: assinale um a um os âmbitos pretendidos.
- Escolha a Expiration: 7 dias, 30 dias, 90 dias, 1 ano, 3 anos, No expiration, ou uma duração personalizada de 1 a 1 095 dias.
- Se necessário, preencha os Allowed IPs e os Allowed User-Agents, separados por vírgulas.
- Clique em Create Key.
A chave só é mostrada uma vez. Copie-a e guarde-a num local seguro antes de fechar a janela.
Os âmbitos disponíveis
| Recurso | Âmbitos |
|---|---|
| Canais | Criar, ler, modificar, eliminar |
| Produtos | Criar, ler, modificar, eliminar |
| Fontes | Ler, depositar ficheiros de origem |
| Workflows | Ler, lançar |
| Organização | Ler a organização, ler os membros |
Revogar uma chave
Na lista, clique em Revoke ao lado da chave. Qualquer integração que a utilize deixa de funcionar de imediato. Esta ação é irreversível.
Bom saber
- Só os proprietários e os administradores criam e revogam as chaves. Os membros veem-nas só de leitura.
- A lista mostra, para cada chave, os seus âmbitos, a sua data de expiração e a sua Last used: uma chave nunca utilizada é muitas vezes uma chave a revogar.
- Lançar um workflow pode envolver muitos produtos e créditos. Só atribua o âmbito de lançamento às integrações que dele precisam.
- Crie uma chave por integração, apenas com os âmbitos necessários.
- Uma chave perdida não pode voltar a ser mostrada: revogue-a e crie uma nova.