Content Type

A CDA (Content Delivery API) é uma API somente leitura que entrega recursos publicados aos visitantes públicos. Esta página trata de como consultar o Content Type publicado, ou seja, o molde (esquema) que o Content segue. Ao ler pela CDA quais campos esse molde tem e qual tipo, condição de multilíngue, obrigatoriedade e regras de validação cada campo possui, você consegue saber de antemão o formato do Content publicado que segue esse molde.

A CDA possui apenas endpoints de consulta (GET); as operações de criar, alterar e publicar um Content Type ficam a cargo do CMA Content Type. Para o comportamento comum da CDA, como autenticação e o modelo de entrega por publicação (snapshot de publicação, revision, apenas o que está publicado fica visível), consulte a Visão geral da CDA. Como o Content Type é o esquema do molde, a consulta não recebe o parâmetro locale.

Estrutura do recurso

A seguir está o formato com que a CDA entrega, em uma única consulta, o Content Type publicado "Produto" do Space de demonstração. Junto com sys (propriedades do sistema), ele possui propriedades de corpo como name, displayField, publishWithAuthor e fields.

{
  "sys": {
    "id": "3trmXRLdJF4GBlAjtcuoZ7Pnxj8dlA",
    "type": "ContentType",
    "space": { "sys": { "id": "HnQ32YiH", "type": "Refer", "targetType": "Space" } },
    "createdAt": "2026-06-14T17:04:46.846Z",
    "updatedAt": "2026-06-17T03:13:49.943Z",
    "revision": 7
  },
  "name": "Produto",
  "displayField": "productName",
  "fields": [
    { "id": "5n06s7ocmwdi", "name": "Nome do produto", "apiName": "productName", "type": "ShortText", "localized": true, "required": true, "validations": [], "disabled": false },
    { "id": "1gecyz8g4llwf", "name": "Preço", "apiName": "price", "type": "Long", "localized": false, "required": false, "validations": [], "disabled": false },
    { "id": "3ow4popgz54zg", "name": "Descrição", "apiName": "description", "type": "RichText", "localized": true, "required": false, "validations": [], "disabled": false },
    { "id": "2alxdptmdub1s", "name": "Foto", "apiName": "photo", "type": "Refer", "localized": false, "required": false, "validations": [], "disabled": false, "targetType": "Media" },
    {
      "id": "2a80lehazfx3t",
      "name": "Marca",
      "apiName": "brand",
      "type": "Refer",
      "localized": false,
      "required": false,
      "validations": [
        { "referContentType": [ { "sys": { "id": "3trmXRM3RqbgSnifyg7OveRYWnJWEG", "type": "Refer", "targetType": "ContentType" } } ] }
      ],
      "disabled": false,
      "targetType": "Content"
    }
  ],
  "publishWithAuthor": false
}

Chaves principais:

• sys.id: identificador único do Content Type. Entra em {contentTypeId} no caminho da consulta individual.
• sys.revision: a versão no momento da publicação. Como a CDA não inclui o version de gerenciamento, o único valor que aponta para a versão publicada é revision.
• name: o nome do Content Type (ex.: Produto).
• displayField: o apiName do campo que representa cada Content na lista do estúdio de conteúdo (ex.: productName).
• publishWithAuthor: indica se as informações do autor são incluídas ao publicar o Content (no exemplo, false).
• fields: a lista de campos que este molde define. A estrutura de cada item é explicada em Campos abaixo.

Propriedades do sistema (sys)

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

Por se tratar de 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 publicada é revision.

Campos

fields é a lista de campos que este Content Type define. Cada item tem a estrutura a seguir (FieldDefinition).

Tipos de campo (type)

type determina como o valor é armazenado e consultado. Alguns tipos têm comportamento de busca diferente.

No exemplo "Produto", Nome do produto é ShortText, Preço é Long, Descrição é RichText, Foto é Refer (targetType: Media) e Marca é Refer (targetType: Content). O campo Marca restringe a referência, por meio de referContentType em validations, apenas ao Content de um Content Type específico (aqui, "Marca", cujo sys.id é 3trmXRM3RqbgSnifyg7OveRYWnJWEG).

O catálogo completo de chaves das regras de validação que podem ser usadas em validations está organizado em CMA Content Type. O snapshot de publicação que a CDA entrega também contém essa mesma estrutura tal como está.

API

A URL base dos dois endpoints abaixo é https://cda.weegloo.com/v1, e é necessário um token Bearer que autentique a CDA no cabeçalho Authorization. Como o Content Type é um molde (esquema), não é algo sobre o qual se escolha um idioma; por isso, diferentemente da consulta de Content, ele não recebe o parâmetro de query locale.

Documentos relacionados

• CMA Content Type: API de gerenciamento para criar e modificar o Content Type (inclui a especificação completa de tipos de campo e validações).
• CDA Content: receber o Content publicado que segue este molde.
• Estados e publicação (conceito): o significado de publicação e versões.