Modern Web (API de conteúdo e webhook)

Publique em qualquer site que não seja WordPress: busque os artigos com uma chave de API (PULL) ou receba-os no seu webhook (PUSH).

«Modern Web Integration» serve para qualquer site que não usa WordPress: um site próprio, um CMS headless, um site estático. Há dois modos, à sua escolha. Com PULL, o seu site busca os artigos no Rankfender com uma chave de API. Com PUSH, o Rankfender envia cada artigo ao seu webhook quando você publica. Está em todos os planos.

Abra com «Connect» (ou «Configure») no cartão em Settings › Integrações. A janela tem duas abas, «PULL (API)» e «PUSH (Webhook)», e está em inglês.

PULL: o seu site busca os artigos

  1. Clique em «Generate API Key»

    A chave aparece com um botão «Copy». A janela lembra de mantê-la em segredo e, em produção, usar variáveis de ambiente e renderização no servidor.

  2. Clique em «Test Connection»

    «Connection successful! API key is valid and working.» confirma a chave.

  3. Copie um exemplo

    Use a chamada direta à API (curl) mostrada no cartão: ela funciona como está e envia a chave no cabeçalho X-Rankfender-Key. Os exemplos de Next.js, React e iframe do cartão dependem de um pacote SDK e de um script de incorporação que não foram publicados, então chame a API diretamente do seu framework.

Parâmetros e respostas: Referência da API de conteúdo e Autenticação.

PUSH: o Rankfender envia cada artigo

CampoO que preencher
Webhook URLO endereço para onde o Rankfender envia os artigos por POST, como https://your-website.com/api/rankfender/publish.
«Authentication Method»None, API Key (cabeçalho X-API-Key), Bearer Token, Basic Auth ou Webhook Secret (cabeçalho X-Webhook-Secret).
A credencialA chave, o token ou o segredo desse método. Fica oculta enquanto você digita.
«Custom Headers (Optional)»Cabeçalhos HTTP adicionais em JSON, como {"X-Custom-Header": "value"}.
«Enable Webhook»Ativado, cada artigo publicado é enviado ao seu webhook.

Clique em «Save Configuration» e depois em «Test Webhook»: o Rankfender envia um artigo de teste chamado «Rankfender Webhook Test» com o cabeçalho X-Rankfender-Test: true. Qualquer resposta 2xx passa no teste. Depois de envios reais, «Last successful call:» mostra a data.

O que o seu endereço recebe

  • Um POST com corpo JSON e os cabeçalhos X-Rankfender-Event: article.published e X-Rankfender-Domain.
  • O artigo: title, slug, content (HTML), excerpt, meta_description, meta_title, keywords, featured_image, author, published_at, além de seo_data e custom_data.
  • O seu endereço deve responder entre 200 e 299. Ele pode devolver {"url": "..."} com o endereço da página publicada.
  • O Rankfender não guarda nada do seu lado: salve os dados no seu próprio banco de dados ou CMS.

Lista completa de campos e cabeçalhos: Webhooks.

Nota

Quais artigos são publicados, e quando, você define em Content: Publicação e piloto automático.