(deprecated) source API de suivi HTTP 1.0

Obsolète

Vous consultez l’ancienne version de l’API (version 1.0) Commanders Act mettra fin au support et à la maintenance de la source HTTP tracking API 1.0 le 31 août 2023. Cette API sera totalement dépréciée en décembre 2023. Après cette date, le format actuel ne sera plus pris en charge et toute requête l’utilisant pourra générer des erreurs.

Nous vous encourageons à commencer à utiliser le nouveau format payload dès que possible afin d’assurer une transition en douceur. Le nouveau format est décrit ici. Veuillez consulter notre documentation pour plus d’informations sur la manière d’utiliser le nouveau format.

Ce qui a changé dans le format payload de la version 1.0 à la version 2.0 :

1. Toutes les données d’événement se trouvaient dans le properties objet. Elles se trouvent désormais à la racine. Le properties cet objet n’existe plus.

2. Toutes les métadonnées contextuelles se trouvaient à la racine, elles se trouvent désormais dans un nouveau context objet. Par exemple, ces objets de métadonnées event_id, device, page, app, event_timestamp se trouvent désormais dans le context objet.

L’API HTTP Tracking 1.0 vous permet d’enregistrer des données depuis n’importe quel site web ou application. Les requêtes sont acheminées vers nos serveurs, et vos données sont acheminées vers toute destination de votre choix.

Configuration

En-têtes

Authentification

Authentifiez-vous auprès de l’API de tracking en envoyant la Clé source avec une requête dans les en-têtes, comme ceci : Authorization: Bearer NJtcKaoCYu...mGZDxRgMBMUw==

La clé source vous est fournie lorsque vous créez une source dans le catalogue des sources

Content-Type

Pour envoyer des données à notre API HTTP, l’en-tête Content-Type doit être défini sur 'application/json'.

Erreurs

Nous renvoyons actuellement une réponse 200 pour toutes les requêtes API ; le débogage doit donc être effectué via l’interface de la plateforme ou notre API de configuration (inspecteur d’événements ou API de livraison d’événements). La seule exception est que si la requête est trop volumineuse ou si le JSON est invalide, elle renverra une erreur 400.

Taille maximale de la requête

La taille maximale est de 32KB par requête API.

Limite de débit

Il n’existe pas de véritable limite de débit au-delà de laquelle le système rejettera vos données. Mais si vous devez importer à un rythme supérieur à 500 requêtes par seconde, veuillez nous contacter au préalable.

API d’événements

Vous pouvez utiliser l’API d’événements pour capturer les actions effectuées par vos utilisateurs. Chaque action donne lieu à ce que l’on appelle un « événement », qui possède des propriétés associées.

Vous devez suivre les activités qui indiquent les performances de votre application, telles que l’inscription, l’achat d’un article et l’ajout d’un article aux favoris. Pour commencer, nous recommandons de suivre seulement quelques événements clés. D’autres pourront facilement être ajoutés plus tard !

Exemple événement appel : (obsolète)

POST  https://collect.commander1.com/events?tc_s={siteId}

{
  "event_name": "search",
  "event_id": "202110130000000000",
  "event_timestamp": 1639044446636,
  "properties": {
      "search_term": "t-shirts", 
      "user": {
          "id": "12345",
          "email":"[e-mail]",
          "consent_categories": [1,3]
      }
  },
  "page": {
    "title": "Search page",
    "location": "https://shop.com/search?q=..."
  },
  "device": {
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2490.86 Safari/537.36",
    "ip": "102.3.4.56", 
    "cookie":"_fbp=123; _fbc=456; _ga=789"
 }
}

Voir les détails sur les bonnes pratiques pour nommer les événements ainsi que le événement payload de la méthode dans notre Spec.

Si vous souhaitez utiliser l’API de tracking HTTP depuis votre application mobile au lieu du SDK, consultez la Spécificités des événements mobiles

Les timestamps pris en charge sont en millisecondes (ms).