Perguntas frequentes

Conceitos

O que é um headless CMS?

Um headless CMS é um sistema de gestão de conteúdo que separa o lugar onde o conteúdo é gerenciado da tela onde o conteúdo é exibido. Aqui, "headless" significa que não há uma tela (UI) fixa acoplada a ele.

Na abordagem tradicional, o lugar onde o conteúdo é gerenciado e a tela do site que o exibe ficam unidos em um só. O headless CMS separa esses dois. O conteúdo é gerenciado em um único lugar, e esse conteúdo é entregue por um canal combinado (a API, uma forma de trocar dados por um endereço seguindo regras definidas). Por isso, o mesmo conteúdo pode ser aproveitado em várias telas diferentes, como um site e um aplicativo móvel.

O WEEGLOO corresponde a esse headless CMS. Quando você cria e publica o conteúdo no estúdio de conteúdo, o site ou o aplicativo busca essa versão publicada e a exibe na tela. O funcionamento completo do WEEGLOO é tratado em Como funciona.

De que forma o conteúdo é fornecido?

O WEEGLOO fornece o conteúdo por uma API RESTful baseada em JSON (um formato de dados baseado em texto, usado ao trocar dados). A API é um canal que troca dados por um endereço seguindo regras definidas.

Conforme o uso, há várias APIs divididas.

• A CDA (Content Delivery API), que lê o conteúdo publicado: usada quando o site ou o aplicativo busca o conteúdo para exibi-lo ao visitante.
• A CMA (Content Management API), que cria e gerencia o conteúdo: usada quando você executa por código tarefas como criar, editar e publicar, que normalmente faria no estúdio de conteúdo.

Como a leitura e a gestão ficam separadas dessa forma, você pode escolher apenas o canal de que precisa em cada ambiente e aproveitar o conteúdo. Qual API usar em cada situação é tratado na Referência da API.

Gestão de conteúdo

Como faço para distribuir conteúdo em vários idiomas?

Para fornecer um Content ou um Media em vários idiomas, primeiro você adiciona o idioma (Locale) ao Space.

1. No menu da esquerda, vá para a tela de gestão de Locales nas configurações do Space.
2. Pressione o botão + Adicionar no canto superior direito e escolha o idioma desejado no menu suspenso.
3. (Opcional) Defina um Locale de fallback. É o idioma que será exibido no lugar quando o valor daquele idioma estiver vazio.
4. Pressione Guardar.

Depois de adicionar o Locale, você precisa ativar o multilíngue em cada Field que vai receber valores por idioma. Na tela de edição do Content Type, abra Configurar Field do Field em questão e, na aba Definições, confirme se Ativar localização para este Field está ativado.

Os detalhes são tratados em Gestão multilíngue.

Como faço a validação de Content?

A validação é o recurso que coloca, em um Field, as condições sobre "os valores que podem entrar neste campo". Valores que não atendem às condições não são salvos, o que impede que Content incorretos se acumulem.

As condições que você pode colocar variam conforme o tipo de Field. Por exemplo, um Field que liga um Media tem condições que restringem os tipos de arquivo que podem ser enviados ou que limitam o tamanho do arquivo e o tamanho da imagem; um Field numérico tem condições que definem o intervalo do valor.

Para adicionar uma validação a um Field, siga estas etapas.

1. Vá para a tela de edição do Content Type e pressione o Field em que vai colocar a condição.
2. Em Configurar Field, vá para a aba Validações.
3. Aparecem as condições disponíveis para aquele tipo de Field. Escolha e configure as condições necessárias.

Os detalhes são tratados em Validação.

Como defino o título de um Content?

O título de um Content é o nome pelo qual você reconhece cada item na lista de Content. Qualquer Field do tipo ShortText pode ser usado como título.

Na tela de edição do Content Type, abra o Field que será o título e indique que esse Field deve ser usado como título. Cada Content Type pode ter apenas um Field como título, então, se outro Field já estiver indicado como título, desfaça essa indicação antes de definir o novo.

O fluxo de indicar um Field como título já na primeira vez em que você o cria é tratado em Modelagem de Content.

Gestão de Organization e Space

Como faço para convidar um usuário?

Para trazer um usuário para um Space, esse usuário precisa primeiro pertencer ao Organization. Por isso, a colaboração começa convidando a pessoa para o Organization.

Convidar um usuário para o Organization é algo que um usuário com o papel de Owner ou Admin pode fazer.

1. Vá para a tela de configurações do Organization.
2. No menu da esquerda, pressione Memberships.
3. Pressione o botão Convidar no canto superior direito e envie o convite preenchendo informações como o e-mail e o papel a atribuir.

O usuário convidado torna-se membro de imediato. Não há uma etapa de "aceitar" à parte, e um e-mail de instruções é enviado para o e-mail convidado.

Os detalhes sobre convites e papéis são tratados em Organization e Space.

API

O valor de sys.id é único?

Sim. O sys.id é gerado de forma única em todo o serviço. Por isso, ele não se repete nem mesmo com recursos que pertencem a outro Organization ou Space.

As informações contidas em sys são tratadas em Propriedades do sistema (sys).

Como consulto os recursos referenciados por um Content?

Usando o parâmetro include, você pode buscar em uma única requisição o Content junto com os recursos referenciados que ele aponta.

GET /v1/spaces/{spaceId}/contents?include=1

A requisição acima consulta a lista de Content e busca, junto, os dados referenciados conectados em um nível de profundidade. Se você aumentar o valor para 2 ou 3, ela expande e busca até níveis mais profundos.

O include pode ser usado da mesma forma não só com Content, mas na consulta de todos os recursos. Os detalhes são tratados em Parâmetros de consulta comuns.

A condição de busca oferece suporte à operação OR?

A REST API não oferece suporte direto ao recurso de combinar várias condições com OR (buscar se ao menos uma das duas for atendida). Se você passar várias condições juntas em uma requisição, o resultado traz apenas o que satisfaz todas elas (AND). Se você precisa de OR, envie uma requisição separada por condição e combine os resultados recebidos.

A forma de estreitar a lista por condições é tratada em Parâmetros de consulta comuns.

Pagamento e tarifas

Posso mudar de plano?

Você pode aumentar (fazer upgrade) ou diminuir (fazer downgrade) o plano a qualquer momento. Ao fazer upgrade, o valor é ajustado proporcionalmente ao período de cobrança restante; o downgrade é aplicado a partir do próximo período de cobrança.

Os limites e os preços por plano são tratados em Planos.

Como é calculado o uso da API?

Muitas plataformas de conteúdo medem o uso pelo número de chamadas à API (número de requisições). O WEEGLOO calcula o uso com base na quantidade de dados de fato trocada (volume de transferência de dados), e não no número de chamadas. Mesmo com o mesmo número de requisições, se os dados trocados forem maiores, mais uso é contabilizado.

Os planos Free, Basic e Pro incluem um volume de transferência de dados definido por mês dentro da tarifa mensal. Na tabela de planos, também é exibido um valor convertido em número de chamadas, para que você consiga estimar esse volume de transferência. Operações em que uma única busca é contabilizada como várias chamadas, como a Advanced Search, também consomem esse volume de transferência.

Se você precisar de um uso maior do que o volume de transferência definido, pode optar pelo plano Enterprise, cobrado conforme o que você usa. Os limites de transferência de dados por plano são tratados em Planos.