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:
- Não cole isso em locais públicos 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 ou no cofre de segredos da sua equipe. Não anote isso em um post-it;
- Não faça o commit nesse código no repositório. 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;
- A chave foi deixada acidentalmente em um lugar onde não deveria estar;
- Uma integração está sendo desativada e você deseja bloqueá-la;
- Você está seguindo uma política de rotação periódica (a cada 90 ou 180 dias, por exemplo).
Não existe motivo “errado” para regenerar a chave. Se você tiver alguma dúvida sobre se a chave ainda está segura, regenere-a.
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.