Contentful
Contentful es un sistema de gestión de contenidos headless que te permite crear, gestionar y distribuir contenidos en cualquier plataforma. A diferencia de un sistema de gestión de contenidos (CMS), Contentful te permite crear tu modelo de contenidos para que puedas decidir qué contenidos quieres gestionar.
Esta página proporciona una guía paso a paso para configurar el contenido conectado de Braze para obtener datos de la API de entrega de contenido de Contentful.
Una vez integrado, puedes utilizar las API RESTful de Contentful para entregar tu contenido a través de múltiples canales, como sitios web, aplicaciones móviles (iOS, Android y Windows) o muchas otras plataformas. También puedes extraer contenido dinámicamente de Contentful para utilizarlo en tus campañas de Braze.
Requisitos previos
Antes de empezar, necesitarás lo siguiente:
| Requisito previo | Descripción |
|---|---|
| Una cuenta de Contentful | Necesitas una cuenta de Contentful con acceso a la API de entrega de contenidos. |
| Una cuenta de Braze | Necesitas una cuenta de Braze con acceso a la característica de contenido conectado. |
Integración
Paso 1: Obtén tus credenciales de API de Contentful
- Inicia sesión en Contentful con tus credenciales.
- Crea o recupera tokens de acceso a la API en el dashboard de Contentful yendo a Settings > API keys. Si aún no tienes una clave de API, crea una nueva:
2.1 Selecciona Add API key.
2.2 Introduce los datos necesarios y selecciona el entorno adecuado.
2.3 Selecciona Save y anota el Space ID y el Content Delivery API - access token. - Identifica el modelo de contenido al que quieres acceder a través de la API de Contentful.
Paso 2: Configura el contenido conectado de Braze
- Inicia sesión en Braze con tus credenciales.
- En el dashboard de Braze, ve a Plantillas > Bloques de contenido > Crear bloque de contenido > Editor de código HTML.
- Crea una solicitud de contenido conectado a la URL de la API de entrega de contenido de Contentful. Un ejemplo de URL de la API de entrega de contenidos de Contentful es
https://cdn.contentful.com/spaces/{space_id}/environments/{environment_id}/entries.
Recuperar distintos activos requiere incluir variables específicas. El ejemplo de solicitud de URL de contenido conectado se dirige al punto de conexión de Entry de Contentful. Este punto de conexión necesita variables como{space_id}y{environment_id}, o{entry_id}y{access_token}. Se pueden tomar de tu instancia de Contentful. En este ejemplo de bloque de contenido, las variables deben sustituirse por tu Space ID y Environment ID de Contentful.
La URL de la API de entrega de contenidos de ejemplo utiliza solo uno de los puntos de conexión disponibles de Contentful. Se pueden conseguir diferentes casos de uso aprovechando diferentes URL. Por ejemplo, la API de imágenes puede utilizarse para capturar imágenes almacenadas en Contentful. Para más información, consulta la API de entrega de contenidos.
Diferentes puntos de conexión pueden requerir nuevas variables; por ejemplo, la API de imágenes requiere un {asset_id}, {unique_id}, y {name}. Para más información, ponte en contacto con Contentful.
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 %}
- Utiliza “Test Endpoint” para comprobar que Braze puede conectarse correctamente a la API de Contentful y recuperar los datos deseados.
- Selecciona Done para guardar tu bloque de contenido.
- Dale a tu bloque de contenido un nombre descriptivo, como “Contentful API”, y luego selecciona Launch Content Block.
Paso 3: Utiliza contenido conectado en campañas y Canvas
- En Braze, crea una nueva campaña o edita una existente.
- Utiliza el bloque de contenido conectado para insertar datos obtenidos de Contentful. Utiliza las rutas de datos que definiste durante la configuración para rellenar dinámicamente el contenido de la campaña.
- Ruta de respuesta: Tras incluir el bloque de contenido en una campaña de Braze o Canvas, la respuesta estará disponible cuando insertes la variable
{response}en tu mensaje.
La notación de puntos JSON te permite especificar qué parte del cuerpo de la respuesta de Contentful quieres incluir en tu mensaje. Esto variará en función de tu caso de uso. Por ejemplo, puedes utilizar el valor del título (liquid{{response.items[0].fields.title}}) del punto de conexión Entry de Contentful y recibir una respuesta como esta:
- Ruta de respuesta: Tras incluir el bloque de contenido en una campaña de Braze o Canvas, la respuesta estará disponible cuando insertes la variable
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
}
}
- Previsualiza y prueba tu campaña para confirmar que los datos de contenido conectado se muestran correctamente.
- Cuando estés satisfecho con la configuración, lanza tu campaña.
Solución de problemas
Respuesta de la API
Asegúrate de que tus credenciales de la API de Contentful y la URL del punto de conexión son correctas. Comprueba si hay mensajes de error en Braze que puedan indicar problemas con la llamada a la API.
Mapeado de datos
Comprueba que los mapeados de la ruta de respuesta están correctamente configurados y que la estructura de respuesta de la API se ajusta a tus expectativas.
Editar esta página en GitHub