Skip to content

Contentful

Contentful é um sistema de gerenciamento de conteúdo headless que permite criar, gerenciar e distribuir conteúdo para qualquer plataforma. Ao contrário de um sistema de gerenciamento de conteúdo (CMS), o Contentful permite que você crie seu modelo de conteúdo para que possa decidir qual conteúdo deseja gerenciar.

Esta página fornece um guia passo a passo para configurar o Conteúdo conectado da Braze para buscar dados da API de Entrega de Conteúdo do Contentful.

Depois de integrado, você pode usar as APIs RESTful do Contentful para entregar seu conteúdo em vários canais, como sites, apps móveis (iOS, Android e Windows) ou muitas outras plataformas. Você também pode extrair dinamicamente conteúdo do Contentful para usar em suas Campaigns da Braze.

Pré-requisitos

Antes de começar, você precisará do seguinte:

Integração

Etapa 1: Obtenha suas credenciais da API do Contentful

  1. Faça login no Contentful com suas credenciais.
  2. Crie ou recupere tokens de acesso da API no dashboard do Contentful acessando Settings > API keys. Se você ainda não tiver uma chave de API, crie uma nova:
    2.1 Selecione Add API key.
    2.2 Insira os detalhes necessários e selecione o ambiente apropriado.
    2.3 Selecione Save e anote o Space ID e o Content Delivery API - access token.
  3. Identifique o modelo de conteúdo que você deseja acessar por meio da API do Contentful.

Etapa 2: Configure o Conteúdo conectado da Braze

  1. Faça login na Braze com suas credenciais.
  2. No dashboard da Braze, acesse Templates > Content Blocks > Create Content Block > HTML code editor.
  3. Crie uma solicitação de Conteúdo conectado para a URL da API de Entrega de Conteúdo do Contentful. Um exemplo de URL da API de Entrega de Conteúdo do Contentful é https://cdn.contentful.com/spaces/{space_id}/environments/{environment_id}/entries.

    A recuperação de diferentes ativos requer a inclusão de variáveis específicas. A solicitação de URL de Conteúdo conectado do exemplo tem como alvo o endpoint Entry do Contentful. Esse endpoint precisa de variáveis como {space_id} e {environment_id}, ou {entry_id} e {access_token}. Esses valores podem ser obtidos da sua instância do Contentful. Neste exemplo de bloco de conteúdo, as variáveis devem ser substituídas pelo seu Space ID e Environment ID do Contentful.

    A URL de exemplo da API de Entrega de Conteúdo usa apenas um dos endpoints disponíveis do Contentful. Diferentes casos de uso podem ser alcançados aproveitando diferentes URLs. Por exemplo, a Image API pode ser usada para capturar imagens armazenadas no Contentful. Para saber mais, consulte a API de Entrega de Conteúdo.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

        {% assign space_id = "YOUR-CONTENTFUL-SPACE-ID"}
        {% assign environment_id = "YOUR-CONTENTFUL-ENVIRONMENT-ID"}
        {% assign entry_id = "YOUR-CONTENTFUL-ENTRY-ID"}
        {% assign access_token = "YOUR-CONTENTFUL-ACCESS-TOKEN"}
         {% assign space_id = "YOUR-CONTENTFUL-SPACE-ID"}
        {% assign environment_id = "YOUR-CONTENTFUL-ENVIRONMENT-ID"}
        {% assign entry_id = "YOUR-CONTENTFUL-ENTRY-ID"}
        {% assign access_token = "YOUR-CONTENTFUL-ACCESS-TOKEN"}
         {% connected_content https://cdn.contentful.com/spaces/{space_id}/environments/{environment_id}/entries/{entry_id}?access_token={access_token}
         :method get
         :headers {
             "Authorization": "YOUR_CONTENTFUL_ACCESS_TOKEN"
                 }
               :content_type application/json
               :save response %}
  1. Use “Test Endpoint” para testar se a Braze consegue se conectar com sucesso à API do Contentful e recuperar os dados desejados.
  2. Selecione Done para salvar seu bloco de conteúdo.
  3. Dê ao seu bloco de conteúdo um nome descritivo, como “API Contentful”, e então selecione Launch Content Block.

Etapa 3: Use o Conteúdo conectado em Campaigns e Canvas

  1. Na Braze, crie uma nova Campaign ou edite uma existente.
  2. Use o bloco de Conteúdo conectado para inserir dados buscados do Contentful. Use os caminhos de dados que você definiu durante a configuração para preencher dinamicamente o conteúdo da Campaign.

    • Caminho de resposta: Após incluir o bloco de conteúdo em uma Campaign ou Canvas da Braze, a resposta se torna disponível quando você insere a variável {response} na sua mensagem.

      A notação de ponto JSON permite que você especifique qual parte do corpo da resposta do Contentful deseja incluir na sua mensagem. Isso vai variar com base no seu caso de uso. Por exemplo, você pode usar o valor do título (liquid{{response.items[0].fields.title}}) do endpoint de Entry do Contentful e receber uma resposta como esta:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

   {
  "fields": {
    "title": {
      "en-US": "Hello!"
    },
    "body": {
      "en-US": "This is a sample message!"
    }
  },
  "metadata": {
    "tags": [
      {
        "sys": {
          "type": "Link",
          "linkType": "Tag",
          "id": "nyCampaign"
        }
      }
    ]
  },
  "sys": {
    "id": "5KsDBWseXY6QegucYAoacS",
    "type": "Entry",
    "version": 1,
    "space": {
      "sys": {
        "type": "Link",
        "linkType": "Space",
        "id": "yadj1kx9rmg0"
      }
    },
    "contentType": {
      "sys": {
        "type": "Link",
        "linkType": "ContentType",
        "id": "hfM9RCJIk0wIm06WkEOQY"
      }
    },
    "createdAt": "2016-12-20T10:43:35.772Z",
    "updatedAt": "2016-12-20T10:43:35.772Z",
    "revision": 1
  }
}
  1. Visualize e teste sua Campaign para confirmar que os dados do Conteúdo conectado são exibidos corretamente.
  2. Quando estiver satisfeito com a configuração, lance sua Campaign.

Solução de problemas

Resposta da API

Certifique-se de que suas credenciais da API do Contentful e a URL do endpoint estão corretas. Verifique se há mensagens de erro na Braze que possam indicar problemas com a chamada da API.

Mapeamento de dados

Verifique se os mapeamentos de caminho de resposta estão configurados corretamente e se a estrutura da resposta da API corresponde às suas expectativas.

Recursos adicionais
New Stuff!