Visão geral do complemento “Pretty Links Developer Tools”

O Pretty Links Developer Tools é um complemento do Pretty Links. Esse complemento permite integrar o Pretty Links a plataformas e plug-ins de terceiros por meio da API REST e de eventos de webhook.

Este documento aborda os conceitos básicos das Ferramentas de Desenvolvedor e seus recursos. 

Observação: Este complemento está disponível nos planos Marketer e Super Affiliate. Se você estiver no plano Beginner ou estiver usando o Pretty Links Lite, você pode atualize seu plano do Pretty Links para usá-lo.

Instalando o complemento “Pretty Links Developer Tools”

Você pode instalar o complemento Developer Tools no painel de controle do seu site:

1. Faça login em seu site como administrador e navegue até Painel > Links bonitos > Complementos.

2. Procurar por Ferramentas para desenvolvedores ou navegue na lista de complementos.
3. Clique no botão Instalar o complemento botão.

Depois que o plug-in estiver instalado, você poderá acessar as opções do Developer Tools em Painel de controle > Pretty Links > Desenvolvedor.

Aqui, você encontrará o menu do complemento com as seguintes opções:

• Webhooks
• Eventos
• API REST

Webhooks

Cada integração que você cria requer uma URL de webhook para que o Pretty Links se comunique com uma plataforma ou plugin de terceiros. A lista de URLs de webhook para todas as suas integrações está no menu “Webhooks”.

Para adicionar o URL do webhook para qualquer nova integração, siga estas etapas: 

1. Navegue até Painel de controle > Pretty Links > Desenvolvedor > Webhooks.
2. Clique no botão "+"Ícone.

3. Adicionar o URL.
4. Clique no botão Avançado para selecionar eventos que devem ser enviados a esse webhook. Você pode escolher Todos os eventos ou eventos específicos necessários para esse webhook.

5. Clique no botão Salvar Webhooks para salvar as alterações.

Chave do webhook

O add-on gera a chave do Webhook automaticamente, que você pode usar para autenticar as solicitações POST.

Observação: Se necessário, você pode gerar uma nova chave de webhook clicando no botão ícone de setas giratórias (ícone "Regenerate Webhook Key") ao lado do campo da chave.

Para validar a solicitação do webhook, obtenha os cabeçalhos HTTP e procure o PRLI-WEBHOOK-KEY cabeçalho. 

Eventos

Sob o Eventos você pode selecionar qualquer evento para obter detalhes sobre ele. Aqui, você pode encontrar informações sobre quando esse evento é acionado e uma amostra da resposta JSON associada.

Você também pode testar o evento clicando no botão Enviar teste button. Dessa forma, você enviará a solicitação POST a todos os webhooks usando esse evento.

API REST

Você pode encontrar o Pretty Links Rotas de API e sua Chave da API sob o API REST opção de menu.

Observação: A API REST pública, compatível com a versão 3, utiliza o pl/v1 namespace. A API de administração do complemento utiliza pl-developer/v1.

Assim como as chaves de webhook, o Developer Tools gera automaticamente uma chave de API exclusiva para autenticação com a API REST. Se necessário, você pode gerar novamente a chave de API clicando no botão ícone de setas giratórias.

Observação: Regeneração Chaves de API e webhook pode interromper as integrações existentes que você criou. Ao regenerar chaves, garantir que suas integrações sejam atualizadas para usar as novas chaves quando necessário.

Selecione a rota da API que você precisa para verificar os detalhes relacionados:

• URL: a rota da API REST;
• Exemplo de solicitaçãoExemplo de como deve ser a solicitação para o evento selecionado;
• ArgumentosArgumentos de pesquisa e atualização: a lista de argumentos de pesquisa e atualização disponíveis;
• Exemplo de respostaExemplo da resposta adequada que você deve receber para o evento selecionado.