Disponível no plano Marketer e nos planos superiores.
A chave da API é a senha que suas outras ferramentas usam para se comunicar com a API REST do Pretty Links. Seu site possui uma chave da API — gerada automaticamente quando as Ferramentas do Desenvolvedor são ativadas — e você pode regenerá-la a qualquer momento.
Este guia faz parte do Visão geral do complemento “Pretty Links Developer Tools”, o ponto de acesso ao complemento “Ferramentas do Desenvolvedor”.
Como localizar e copiar sua chave
- No painel de administração do WordPress, acesse Painel > Pretty Links > Ferramentas do desenvolvedor.
- Abra o Chave da API seção.
- Sua chave atual é exibida na tela. Clique em Copiar para copiá-lo para a área de transferência.
A chave é uma sequência alfanumérica de 10 caracteres (combinando letras maiúsculas, minúsculas e dígitos). Cole-a na ferramenta que precisar acessar a API.
Envio da chave em uma solicitação
A API REST aceita a chave em qualquer um dos dois cabeçalhos HTTP:
PRLI-API-KEY: sua-chave-aqui;Autorização: yourkeyhere.
A maioria das ferramentas possui um campo chamado “Chave de API” ou “Autorização” — cole sua chave nesse campo. No aplicativo Documentos aba (em Painel > Pretty Links > Ferramentas do desenvolvedor > Documentação) mostra o formato exato do cabeçalho e um exemplo de comando `curl` que você pode copiar.
Como guardar a chave com segurança
Trate a chave da API como se fosse uma senha:
- Don’t paste it into public places como canais do Slack, tickets de suporte ou issues do GitHub. Qualquer pessoa que tenha a chave pode ler e modificar seus Pretty Links;
- Guarde-a em um gerenciador de senhas or your team’s secrets vault. Don’t write it on a sticky note;
- Don’t commit it to a repository. Se o seu código de integração estiver no Git, leia a chave a partir de uma variável de ambiente ou de um gerenciador de segredos — nunca a insira diretamente no código.
Regeneração da chave
Se a chave vazar, for perdida ou você quiser uma nova, gere-a novamente:
- Ir para Painel > Pretty Links > Ferramentas do desenvolvedor.
- No Chave da API seção, clique em Regenerar.
- Confirme a ação.
A regeneração invalida imediatamente a chave antiga e a substitui por uma nova. Qualquer sistema que ainda estiver usando a chave antiga começará a apresentar erros de autenticação — atualize esses sistemas com a nova chave o mais rápido possível.
Quando regenerar
Você deve alternar ou regenerar a chave quando:
- Um funcionário com acesso à chave deixa a equipe;
- The key was accidentally posted somewhere it shouldn’t have been;
- Uma integração está sendo desativada e você deseja bloqueá-la;
- You’re following a periodic rotation policy (every 90 or 180 days, for example).
There’s no “wrong” reason to regenerate. If you have any doubt about whether the key is still secure, regenerate it.
Uma chave por local
O Developer Tools utiliza uma única chave de API para todo o site, em vez de chaves específicas para cada integração. Isso simplifica a administração, mas significa que a rotação da chave afeta todas as integrações de uma só vez — portanto, planeje a rotação para um momento em que você possa atualizar todas as suas ferramentas conectadas (Zapier, scripts, painéis) na mesma sessão.