Content

A CDA (Content Delivery API) é uma API somente de leitura que entrega recursos publicados aos visitantes públicos. Esta página trata de como consultar Content publicado, ou seja, cada registro de dados real criado seguindo o molde chamado Content Type. A CDA entrega o snapshot do momento da publicação, portanto os rascunhos que ainda não foram publicados no estúdio de conteúdo não aparecem aqui.

A CDA possui apenas endpoints de consulta (GET); criar, alterar e publicar Content é responsabilidade da CMA Content. Para os comportamentos comuns da CDA, como autenticação e o modelo de entrega por publicação (snapshot de publicação, revision, apenas o publicado fica visível, exposição do autor dependente de publishWithAuthor), consulte a Visão geral da CDA. Como definir o idioma a receber com locale é tratado abaixo em locale e fields.

Estrutura do recurso

Veja a seguir o formato que a CDA entrega ao consultar individualmente, com locale=ko-KR, um Content publicado da Space de demonstração (o produto "스테인리스 텀블러 500ml"). Junto com sys (propriedades de sistema), ele possui fields, que contém os valores dos campos do Content Type que este Content segue.

{
  "sys": {
    "id": "3trmXRM3RqbgSnifyg7OGhwhlqvAvq",
    "type": "Content",
    "space": { "sys": { "id": "HnQ32YiH", "type": "Refer", "targetType": "Space" } },
    "contentType": { "sys": { "id": "3trmXRLdJF4GBlAjtcuoZ7Pnxj8dlA", "type": "Refer", "targetType": "ContentType" } },
    "createdAt": "2026-06-15T15:16:12.151Z",
    "updatedAt": "2026-06-16T14:31:20.073Z",
    "revision": 3
  },
  "fields": {
    "price": 18000,
    "description": "이중 진공 단열로 보온·보냉이 오래갑니다. 500ml 대용량.",
    "photo": null,
    "productName": "스테인리스 텀블러 500ml"
  }
}

Chaves principais:

• sys.id: identificador único do Content. Entra no {contentId} do caminho de consulta individual.
• sys.contentType: é um Refer que aponta para o Content Type (molde) que este Content segue. O sys.id é o identificador desse Content Type, e quais campos ele possui pode ser lido em CDA Content Type.
• sys.revision: a versão no momento em que foi publicado. A CDA não inclui o version de gestão, portanto o único valor que aponta para a versão de publicação é revision.
• fields: um objeto que tem como chave o apiName de cada campo do Content Type. O valor é um único valor do locale solicitado (não é um mapa de locales). O photo do exemplo acima é null porque não há Media vinculado.

Propriedades de sistema (sys)

O sys de um Content publicado contém apenas propriedades destinadas ao snapshot de publicação. space, contentType, createdBy e updatedBy entram no formato Refer ({ "sys": { "id", "type": "Refer", "targetType" } }).

Por ser um snapshot de publicação, version, status, publish e archive, que existem no sys da CMA, não são incluídos. O único valor que aponta para a versão de publicação é revision.

locale e fields

O parâmetro de consulta locale define em qual idioma os dados serão recebidos. Funciona de três maneiras.

• Ao informar um código, como locale=ko-KR, fields é devolvido com um único valor desse locale. Diferentemente da CMA, que devolve um mapa contendo todos os valores por locale, como fields.productName.ko-KR, a CDA seleciona o valor de um único locale solicitado e o coloca diretamente em fields.productName. Se não houver valor e o Fallback também não alcançar, esse campo fica null (o photo da Estrutura do recurso acima é null porque não há Media vinculado).
• Ao omitir locale, o valor é devolvido da mesma maneira, usando o Locale padrão da Space.
• Ao informar locale=*, o valor não é escolhido por um único idioma; em vez disso, é devolvido o mapa contendo todos os valores por locale (fields.productName.ko-KR), como na CMA.

Ao receber um único idioma por código ou por omissão, a resposta inclui o cabeçalho x-weegloo-locale, que informa o locale realmente utilizado (não é incluído quando locale=*). A seleção do valor de locale e as regras de Fallback são tratadas em Multilíngue (conceito).

API

A URL base dos quatro endpoints a seguir é https://cda.weegloo.com/v1, e o cabeçalho Authorization requer um token Bearer que autentica na CDA. Os quatro endpoints recebem o parâmetro de consulta locale (veja locale e fields acima). Os dois primeiros endpoints abrangem o Content publicado de toda a Space, e os dois últimos abrangem apenas o Content pertencente a um Content Type específico.

Ao filtrar ou ordenar os dois primeiros endpoints (a lista plana de todo o Content publicado da Space) por fields.*, você deve indicar também o Content Type com sys.contentType.sys.id={contentTypeId}. A forma contentType={contentTypeId} não o substitui. Os dois últimos endpoints já têm o Content Type explícito no caminho, portanto não é preciso indicá-lo separadamente.

Documentos relacionados

• CDA Content Type: o molde de publicação que este Content segue.
• CDA Media: os recursos de arquivo publicados que o Content referencia.
• CMA Content: a API de gestão que cria e modifica Content.
• Multilíngue (conceito): comportamento de locale e fallback.