Pular para o conteúdo
Delivery API
Antes de planejar em torno de um recurso, confira o status dos recursos.

Visão geralComece aqui

Como o Atlas funciona

Organizações, sites, ambientes, o contrato do site, a publicação e a entrega em uma única página.

Esta página foi traduzida do inglês. Se houver qualquer diferença, vale a versão em inglês. Ler em inglês

Conceito O que é
Organização Sua empresa. Ela é dona dos sites, das pessoas e do plano.
Site Um site. O conteúdo, a mídia, o acesso das pessoas e as configurações nunca passam de um site para outro.
Ambiente Cada site tem Development e Production. Você trabalha em Development; o Production serve apenas um release aprovado.
Contrato do site Uma descrição em JSON do seu site: seus componentes e os campos tipados deles, tipos de página, coleções, globais de cabeçalho/rodapé, perfis de mídia e design tokens.
Página Uma rota do seu site (por exemplo /about), composta por seções. Cada seção é um dos componentes do seu contrato, com seus valores de campo.
Entrada Um item de uma coleção, como um produto ou uma notícia.
Global Conteúdo compartilhado entre páginas, como o cabeçalho e o rodapé do site.
Token de entrega Um token exclusivo do servidor que seu site usa para ler o conteúdo publicado de um ambiente.
Editor in Studio ──draft──▶ Atlas (Development) ──publish──▶ published revision
│
your website server ◀── Delivery API (HTTPS, delivery token)
│
your components render it ──▶ visitors
  1. Seus desenvolvedores descrevem o site no contrato do site. Um administrador do site o ativa no Studio.
  2. Os editores criam e alteram páginas e entradas como rascunhos. Os rascunhos nunca aparecem no site público.
  3. Os editores fazem a pré-visualização de um rascunho dentro do design real do seu site e depois publicam. Cada publicação é uma revisão imutável, então você pode reverter.
  4. Seu site lê o conteúdo publicado na Delivery API com seu token de entrega, apenas a partir de código de servidor.
  5. O Atlas envia um webhook assinado ao publicar, para que seu site atualize apenas as páginas afetadas.
  • Todo site novo começa em Development. O conteúdo é editado e publicado ali.
  • O Production fica desativado até que um administrador do site o ative, depois que um release passou em todas as verificações e uma pessoa com permissão de aprovação o aprovou.
  • O Production serve apenas o seu release assinado e ativo: um instantâneo congelado do conteúdo aprovado. Editar o Development nunca altera o Production até o próximo release aprovado.
  • Trocar de ambiente no Studio apenas muda o que você está vendo. Isso nunca altera o conteúdo.

Mais informações: Development e Production.

O Atlas não roda no seu site. Seus desenvolvedores adicionam uma pequena quantidade de código:

  • um cliente exclusivo do servidor para a Delivery API;
  • a renderização das seções pelos seus componentes existentes;
  • um fallback: se o Atlas estiver inacessível ou não tiver nada publicado para uma página, o site serve o conteúdo embutido nele;
  • uma rota de pré-visualização de rascunhos, um receptor de webhooks e um relatório de build.

O guia de conexão mostra cada um desses passos.