Postream

Carregando o índice…

Documentação: Buscar um post

Buscar um post

Um post publicado pelo slug, com o corpo em HTML e em Markdown.

GET/public/v1/sites/{siteId}/posts/:slug

GET/public/v1/posts/:slug

A primeira é a rota por site (só chave secreta, guardada na borda por até um dia e purgada quando o post muda); a segunda é a rota pela chave (secreta ou publicável). Veja Duas rotas.

Parâmetros

ParâmetroPadrãoDescrição
slugcaminhoobrigatório—Slug da versão do post, como aparece na lista.
localetexto—Idioma da versão. Sem ele, um slug que exista em mais de um idioma resolve para o idioma principal do site.

Resposta

Os mesmos campos de um item da lista, dentro de data, e mais:

  • bodyHtml: o corpo renderizado. HTML cru vindo do Markdown é escapado e links javascript: são descartados, então dá para injetar direto na página.
  • bodyMarkdown: o corpo em Markdown. O título não está no corpo (vem em title).
{
  "data": {
    "id": "7c0e…",
    "locale": "pt-BR",
    "slug": "como-gerir-varios-blogs",
    "title": "Como gerir vários blogs",
    "bodyHtml": "<p>…</p>",
    "bodyMarkdown": "…",
    "…": "os demais campos da lista"
  }
}

Slug inexistente, não publicado ou de outro site responde 404 NOT_FOUND.

Slug antigo: 301

Quando alguém muda no painel o slug de uma versão publicada, o slug anterior continua apontando para ela. Pedir o slug antigo responde 301 Moved Permanently:

HTTP/1.1 301 Moved Permanently
Location: slug-novo?locale=pt-BR
Cache-Control: private, no-cache
 
{ "redirectTo": { "slug": "slug-novo", "locale": "pt-BR" } }
  • Location é relativo ao próprio endpoint (/public/v1/posts/slug-novo?locale=pt-BR).
  • Todos os slugs antigos de uma versão apontam direto para o atual, sem cadeia de redirects.
  • Voltar a um slug antigo faz ele valer de novo; o que foi deixado passa a redirecionar.
  • O slug antigo segue reservado: outro post do mesmo site e idioma não pode usá-lo. Outro idioma ou outro site podem.
  • Sem ?locale=, um slug vigente em qualquer idioma ganha de um slug antigo.
  • Se a versão sair do ar (despublicada ou excluída), o slug antigo responde 404. Excluir o post libera os slugs antigos dele.
  • Versões nunca publicadas não guardam slug antigo: ninguém tinha o link.

O fetch segue o 301 sozinho (o Authorization vai junto, porque o destino é a mesma origem) e devolve o post com o slug atual. Por isso o blog só precisa comparar: se data.slug for diferente do slug da URL, mande o visitante (e o Google) para a URL nova com redirect permanente, como no exemplo com Next.js. Quem prefere não seguir pode usar redirect: "manual" no servidor e ler redirectTo do corpo.

Exemplos

curl -L -H "Authorization: Bearer $POSTREAM_API_KEY" \
  "https://api.postream.blog/public/v1/sites/$POSTREAM_SITE_ID/posts/como-gerir-varios-blogs?locale=pt-BR"