Disponível no plano Marketer e nos planos superiores.
Esta página oferece uma orientação geral. A referência completa e sempre atualizada da API REST está disponível no painel de administração do WordPress — acesse Painel > Pretty Links > Ferramentas do desenvolvedor > Documentação para ver exemplos completos de solicitações e respostas.
Este guia faz parte do Visão geral do complemento “Pretty Links Developer Tools”, o ponto de acesso ao complemento “Ferramentas do Desenvolvedor”.
Onde encontrar a referência completa
Na barra lateral de administração do WordPress, acesse Painel > Pretty Links > Ferramentas do desenvolvedor > Documentação.
A aba “Documentação” exibe todos os endpoints com seu método HTTP, parâmetros, formato do corpo da solicitação, formato da resposta e exemplos de chamadas. Como é hospedada dentro da sua instalação, ela sempre corresponde à sua versão atual do Pretty Links — sem precisar se preocupar com documentação online desatualizada.
Abra a aba “Docs” em uma segunda aba do navegador enquanto trabalha. Ela é a fonte de referência.
Visão geral dos terminais
Aqui está um resumo rápido do que está disponível, para que você saiba o que é possível fazer antes de se aprofundar na documentação do aplicativo.
Pretty Links (CRUD)
- Listar links bonitos — Veja todos os seus Pretty Links, com filtragem e paginação;
- Obtenha um único Pretty Link — Pesquisar um link pelo ID;
- Criar um link bonito — Adicionar um novo link programaticamente. Útil para migrações, importações em massa ou criação automática de links a partir de outro sistema;
- Atualizar um Pretty Link — Modificar a URL de destino, o slug, o tipo de redirecionamento, o nome ou outros campos de um link existente;
- Excluir um link simplificado — Enviar para a lixeira ou excluir definitivamente um link.
Assinaturas de webhooks
- Inscreva-se — Criar uma nova assinatura de webhook programaticamente (POST);
- Cancelar inscrição — Remover uma assinatura de webhook pelo ID (DELETE).
Isso é útil quando um sistema externo precisa gerenciar o próprio ciclo de vida de suas assinaturas de webhooks — por exemplo, uma integração que deseja se registrar ao ser ativada e se desregistrar ao ser desativada. Para visualizar a lista atual de assinaturas, use a tela “Webhooks” no painel de administração.
Autenticação
Todas as chamadas de API exigem a chave de API do site, enviada no PRLI-API-KEY cabeçalho ou o Autorização cabeçalho. Veja Chaves de API para saber onde encontrá-la e como regenerá-la.
O namespace REST é pl/v1 — por exemplo, https://yoursite.com/wp-json/pl/v1/links.
A guia “Docs” no aplicativo mostra o formato exato do cabeçalho e um exemplo de comando curl que você pode copiar.
Formato da resposta
Todas as respostas são em JSON. As respostas bem-sucedidas retornam um código de status 2xx com os dados relevantes no corpo da resposta. Os erros retornam um código de status 4xx ou 5xx com um corpo em JSON descrevendo o que deu errado.
Aplicam-se as convenções padrão do HTTP:
200 OK— Leitura bem-sucedida;201 Criado— Criação bem-sucedida;400 Solicitação inválida— Sua solicitação estava com formato incorreto;401 Acesso não autorizado— Chave de API ausente ou inválida;404 Não encontrado— O link ou recurso não existe;Erro 500 do servidor interno— Ocorreu um problema no servidor.
Dicas para trabalhar com a API
Comece com uma chamada à função `List`. A primeira solicitação a ser testada é “listar todos os meus Pretty Links”. Ela verifica se sua chave de API, o formato da URL e a configuração da sua ferramenta estão corretos — tudo de uma só vez.
Leia a documentação do aplicativo para saber os nomes exatos dos campos. A lista de campos de um Pretty Link está documentada no painel de administração. Não tente adivinhar os nomes dos campos; copie-os da documentação para evitar erros de digitação.
Teste primeiro as chamadas de criação e atualização em um site de teste. Um erro de digitação em um script de criação em massa pode gerar centenas de links inválidos. Execute-o em um ambiente de teste, verifique o resultado e, em seguida, aplique-o ao ambiente de produção.
Use webhooks em vez de polling. Se você estiver acessando o endpoint “List” periodicamente para verificar se há alterações, configure uma assinatura de webhook. Assim, você receberá as alterações em tempo real, sem se preocupar com limites de frequência.
Verifique o log de eventos caso um webhook não esteja sendo acionado. Não presuma — verifique. O log de eventos mostra se o Pretty Links realmente enviou a solicitação e qual foi a resposta devolvida pelo seu endpoint.
Para tudo o mais, a aba “Documentos” do aplicativo é a fonte de referência. Adicione-a aos favoritos.