O complemento Easy Affiliate Developer Tools amplia o Easy Affiliate para incluir uma API REST completa e a capacidade de eventos Webhook completos. Isso significa que você pode usar o add-on para integrar o Easy Affiliate com plataformas e plugins de terceiros.
Este documento fornecerá uma visão geral básica do add-on e de seus recursos.
Observação: Easy Affiliate Developer Tools add-on is available with the Easy Affiliate Pro plan.
Instruções de configuração de vídeo
Instalação do Easy Affiliate Developer Tools Add-on
Você pode instalar o add-on Developer Tools da mesma forma que qualquer outro add-on do Easy Affiliate:
- No painel do WordPress, navegue até Afiliado fácil > Complementos;
- Procurar por Ferramentas do desenvolvedorou navegue na lista de complementos;
- Clique no botão Instalar o complemento botão.
Depois que o plug-in estiver instalado, você poderá acessar as opções de Ferramentas do desenvolvedor em seu WordPress Painel de controle > Afiliado fácil > Desenvolvedor.
Aqui, você encontrará as seguintes opções:
Webhooks
O Easy Affiliate usa URLs de webhook para se comunicar com qualquer plataforma ou plug-in de terceiros por meio das integrações que você cria.
Sob o Webhooks você pode adicionar um URL de webhook para cada uma de suas integrações. Para criar webhooks adicionais, basta clicar no ícone "+"Ícone.
Uma vez criado, cada URL de webhook vem com o Avançado opção usada para selecionar eventos que devem ser enviados a esse webhook.
Aqui, você pode selecionar Todos os eventos ou os específicos para esse webhook.
Chave do webhook
Você pode usar a chave para autenticar solicitações POST de webhook. Essa chave é gerada automaticamente pelo complemento Developer Tools.
Observação: Se você acredita que sua chave de webhook foi comprometida, é possível gerar uma nova chave de webhook a qualquer momento 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, busque os cabeçalhos HTTP e procure o esaf-webhook-key. Aqui está um exemplo de um cabeçalho HTTP com a chave do webhook recebida:
Eventos
O Eventos permite que você visualize a documentação dinâmica sobre os eventos de webhook disponíveis.
Você pode selecionar qualquer evento para obter detalhes sobre quando esse evento é acionado, bem como uma amostra da resposta JSON associada a ele.
Você também pode testar eventos enviando uma solicitação POST de um evento escolhido para todos os webhooks listados em Webhooks opção.
API REST
O API REST A opção de menu contém sua chave de API e uma lista de URLs para todas as rotas disponíveis da API REST do Easy Affiliate.
Your unique API key is automatically generated by the Developer Tools add-on and can be used to authenticate with the REST API. If needed, you can regenerate the API key by clicking the ícone de setas giratórias.
Note: Regenerating API and webhook keys can break existing integrations you created. When regenerating keys, ensure your integrations are updated to use the new keys where needed.
Aqui você também pode encontrar documentação dinâmica sobre rotas de API REST. Selecione a rota de API de que você precisa e verifique todos os detalhes relacionados:
- URL
- Exemplo de solicitação
- Argumentos
- Exemplo de resposta
