Diffusion de fragments de contenu AEM avec OpenAPI aem-content-fragment-delivery-with-openapi
Dans Adobe Experience Manager (AEM) as a Cloud Service, l’OpenAPI AEM pour la diffusion de fragments de contenu :
- est une OpenAPI optimisée pour la diffusion en direct de fragments de contenu AEM au format JSON
- se concentre sur la diffusion de contenu (performances, évolutivité, intégration CDN, contrôle et sortie JSON optimisés)
- inclut la possibilité d’hydrater du code JSON pour les fragments et les ressources référencés
Cette API :
-
est le successeur de Prise en charge des fragments de contenu dans l’API HTTP AEM Assets
-
complète les API ouvertes de fragments de contenu et de modèles de fragments de contenu, qui vous permettent de gérer les fragments de contenu et les modèles de fragment de contenu (CRUD)
-
est une alternative HTTP REST à l’API AEM GraphQL à utiliser avec des fragments de contenu
Pour consulter la documentation complète, voir Diffusion de fragments de contenu AEM avec OpenAPI.
- le programme Cloud Service et les identifiants d’environnement ;
- détails du cas d’utilisation que vous souhaitez résoudre avec l’OpenAPI de diffusion de fragments de contenu.
- détails de tous les contacts auxquels Adobe doit répondre et qui doivent être tenus informés de la demande et du projet (si nécessaire)
Mise en cache caching
AEM s’intègre au réseau CDN d’AEM rapidement. Cela signifie que les réponses JSON diffusées au niveau de publication sont mises en cache au niveau Fastly .
Les réponses sont ensuite mises en cache, en fonction des en-têtes de mise en cache prédéfinis (ne peuvent pas être configurés) :
- Les réponses sont mises en cache pendant 5 minutes dans le cache du navigateur/client
max-age=300
- Les réponses sont mises en cache pendant 1 heure sur le cache CDN.
s-maxage=3600
- Le contenu obsolète peut être diffusé lors de la revalidation des nouvelles requêtes pendant une heure maximum
stale-while-revalidate=3600
- Le contenu obsolète peut être diffusé, par erreur, pendant 1 jour au maximum
stale-on-error=86400
Disponibilité availability
La diffusion de fragments de contenu avec OpenAPI est disponible sur les niveaux Aperçu et Publication. L’API OpenAPI diffuse des fragments de contenu au format JSON pour la prévisualisation et la diffusion en direct.
Pour obtenir un aperçu, la diffusion de fragments de contenu avec OpenAPI peut :
- Publier dans l’aperçu
- Activer l’accès à l’aperçu avec la liste autorisée IP
- obtenir l’URL d’aperçu
CORS cors
Origines autorisées CORS définissez les origines qui peuvent appeler l’API.
Les origines autorisées CORS définies du côté de la configuration du Dispatcher, spécifiquement pour GraphQL, ne sont pas prises en compte par cette API.
Limites de taux d’API api-rate-limits
L’API autorise de nouvelles requêtes à raison de 200 requêtes maximum par seconde et par environnement.
Une fois cette limite dépassée, l’API commence à envoyer des réponses d’erreur 429. Ces erreurs doivent être gérées par toutes les applications clientes et les requêtes ayant échoué doivent être relancées à la suite d’une reprise exponentielle. La réponse HTTP s’accompagne d’un en-tête spécifique, Retry-After, qui indique au client combien de temps il doit attendre avant de renvoyer la requête.
Requêtes authentifiées authenticated-requests
La prise en charge des requêtes authentifiées peut être mise en œuvre avec la clé Edge CDN AEM. L’utilisation de la clé Edge du réseau CDN AEM vous permet de vous fier au réseau CDN AEM et de vous assurer que seules des requêtes spécifiques peuvent accéder à l’API, en fonction de l’en-tête de clé Edge fourni.
Diffuser un élément composite deliver-a-composite-item
Vous pouvez diffuser vos éléments composites avec les API suivantes :
-
À partir de l’OpenAPI Management (API de gestion des fragments de contenu)
-
l’API de diffusion REST. Il existe deux chemins :
- précuit au moment de la publication
- diffusion en cours à partir d’AEM
-
Pour les réponses OpenAPI contenant des fragments référencés hydratés, les composites peuvent réduire la surcharge en termes de références et de métadonnées de fragment. La taille de la payload dépend de la structure du contenu et des options d’inclusion de référence. Le contenu composite incorporé est inclus indépendamment de la profondeur de référence, de sorte que les réponses superficielles peuvent être plus importantes que les réponses équivalentes basées sur la référence.