Como criar uma chave de API?

Onde: Definições → Avançadas → Ligar outras aplicações

Abra esta página: admin.<your-site>/settings/integrations (substitua <your-site> pelo endereço do seu site). Se não a vir no menu, ative a opção Mostrar todas as definições na página de Definições.

Antes de começar

• Apenas o proprietário do site pode criar chaves.

Passo a passo

1. Abra o separador Definições → Avançadas → Ligar outras apps → Chaves de API.
2. Prima Criar chave.
3. Introduza um Nome, por exemplo "Site de parceiro".
4. Sob O que pode fazer?, selecione o que for necessário:
   • Ler notícias: artigos publicados, sem conteúdo pago.
   • Ler texto integral com paywall: inclui também o texto integral de artigos pagos.
   • Enviar rascunhos: cria artigos como rascunhos. Nada é publicado sem a intervenção da sua equipa.
   • Enviar fotografias: adiciona fotografias à sua biblioteca de multimédia a partir de um endereço web.
   • Ler secções e etiquetas.
   • Ler dados de tráfego: visualizações de artigos e total de visitantes.
   • Ler relatórios financeiros: apenas totais, nunca os dados dos leitores.
5. Opcional: defina a Expira em, Apenas a partir destes endereços (um por linha, até 20), Pedidos por minuto (1 a 600) e Pedidos por dia (1 a 1 000 000).
6. Prima Criar chave.
7. Copie a chave da caixa. Esta é a única vez em que a poderá ver. Prima Já guardei.
8. Entregue a chave à outra aplicação. Ela deve enviá-la no cabeçalho "Authorization: Bearer".

Informações úteis

• A lista apresenta o Nome, Pode fazer, Última utilização, Expira e Estado de cada chave: A funcionar, Expirado ou Parado.
• O botão Criar uma nova chave substitui a chave. A antiga continua a funcionar durante o período que escolher, ou escolha Parar agora se achar que a chave foi comprometida.
• O botão Parar chave rejeita imediatamente todos os pedidos efetuados com essa chave. Não é possível anular esta ação. Crie uma nova chave para voltar a dar acesso à aplicação.
• Os detalhes de cada chave mostram a respetiva utilização nos últimos 30 dias.
• Cada chave tem os seus próprios limites. Uma aplicação que faça demasiados pedidos terá o ritmo abrandado.
• Uma chave com acesso a texto sob paywall permite a qualquer pessoa ler conteúdos pagos pelos seus subscritores. Guarde-a com cuidado.

Problemas comuns

• "Atingiu o número máximo de chaves que pode ter. Desative primeiro uma chave que já não utilize."
• "Dê um nome à chave."
• "Escolha pelo menos uma ação permitida para esta chave."
• "Escolha uma data no futuro."

Perguntas frequentes

Artigos relacionados

• Ligar outras apps
• Webhooks