A sua chave de API
Crie a chave de API de um projeto no cartão Modern Web, envie-a no cabeçalho X-Rankfender-Key e substitua-a com segurança.
A API de conteúdo sabe de que projeto se trata pela chave de API. Cada projeto tem a sua própria chave, criada no seu cartão «Modern Web Integration». A chave só lê os artigos publicados desse projeto.
Criar a chave
Abra o cartão
Settings › Integrações e depois «Conectar» (ou «Configure») em «Modern Web Integration». Fique na aba «PULL (API)».
Clique em «Generate API Key»
A chave aparece com um botão «Copy». Começa por rfk_ seguido de 64 letras e algarismos.
Clique em «Test Connection»
«Connection successful! API key is valid and working.» confirma-a.
Envie-a em cada pedido
Coloque a chave no cabeçalho X-Rankfender-Key. Não há outra forma de a enviar.
curl "https://odbowhcyfpzsifyibsdu.supabase.co/functions/v1/public-article-api?limit=1" \
-H "X-Rankfender-Key: rfk_your_key"| Resposta | Significado |
|---|---|
| 401 «API key required. Pass via X-Rankfender-Key header.» | Falta o cabeçalho. |
| 401 «Invalid API key» | A chave não corresponde a nenhum projeto, por exemplo depois de ser substituída. |
Substituir uma chave
Clique de novo em «Generate API Key». A nova chave substitui a antiga de imediato: qualquer site que ainda use a antiga recebe «Invalid API key» até você o atualizar.
Importante
Quem tiver a chave pode ler os artigos publicados do projeto. Guarde-a no seu servidor, numa variável de ambiente, e chame a API a partir de código no servidor, não no navegador.
Configurações da conta › «Chaves API» mostra «API key management coming soon»: as chaves gerem-se por projeto, como acima. A seguir: Referência da API de conteúdo.