Comment fonctionne CitrusAd ?
L'API CitrusAd repose sur le style d'architecture REST. Elle comporte des URL prévisibles orientées ressources et utilise des codes de réponse HTTP pour indiquer les erreurs d'API. Elle utilise des fonctions HTTP intégrées, notamment l'authentification HTTP et les verbes HTTP, qui sont compris par les clients HTTP standard.
L'authentification auprès de l'API CitrusAd est assurée par des clés API, qui sont utilisées lors de la communication entre votre back-end et l'API CitrusAd.
L'API CitrusAd prend en charge l'importation de produits, de catalogues, de clients et de données de commande, qui sont utilisés pour générer des annonces. Vous pouvez utiliser l'API CitrusAd pour effectuer des requêtes d'annonces et établir des rapports sur les interactions avec ces annonces.
Points de terminaison CitrusAd
CitrusAd utilise divers points de terminaison afin de synchroniser les données et générer des annonces. Voici un bref résumé :
| Point de terminaison | Utilisation | Description |
|---|---|---|
catalogs | Synchroniser les catalogues via l'API | Sert à créer des catalogues par l'API. Pour les espaces de noms de catalogues uniques, veuillez vous adresser à votre responsable de compte technique. |
catalog-products | Synchroniser les produits par l'API | Sert à créer et mettre à jour les données de produits d'un catalogue. |
customers | Synchroniser les données client par l'API | Sert à créer et mettre à jour les données client d'un catalogue. |
orders | Synchroniser les données de commande par l'API | Sert à envoyer les données de commande à CitrusAd. |
/resource/ | Comptabiliser les clics et les impressions, Synchroniser les données de commande via l'API | Sert à comptabiliser les clics et les impressions, ainsi que les commandes en cas de rapport via le front-end. |
/ads/generate | Générer des annonces | Sert à générer des annonces de produits et des bannières publicitaires. |
/ads/bannerx | Générer des annonces | Sert à générer des bannières publicitaires X. |
Il est inutile d'utiliser des points de terminaison pour la synchronisation des catalogues, des produits, des clients et des commandes. En effet, CitrusAd prend en charge la synchronisation des données par fichier, le cas échéant.
Type de contenu et charge utile
La charge utile des données se présente au format JSON. L'AD_ID Content-Type pour ces points de terminaison est application/json, qui doit être transmis en tant qu'en-tête dans vos requêtes comme suit :
-H "Content-Type: application/json" \
Authentification des requêtes
Authentification de base
Toutes les ressources d'intégration utilisent une authentification de base qui doit être transmise en tant qu'en-tête avec votre clé API comme suit :
-H "Authorization: Basic 4ww25f70-b52s-40de-8f29-07b139b5cdc8" \
Votre clé API est accessible dans la section Paramètres d'intégration de l'équipe détaillant. Vous aurez uniquement besoin de la clé API secrète.
Authentification OAuth2.0
Le point de terminaison de génération d'annonces de CitrusAd est également compatible avec OAuth2.0. Consultez la section Authentification OAuth 2.0 pour en savoir plus.
URL de base
CitrusAd utilise des URL de base différentes pour les environnements de staging et de production.
Pour recevoir votre URL de base de staging, veuillez contacter CitrusAd. Une fois votre intégration en cours, nous vous fournirons les URL de base de production.