Source API de tracking HTTP

version 2.0

L'API HTTP Tracking est utilisée pour suivre events depuis n'importe quel site web, application ou serveur. Les données sont collectées par nos serveurs, puis traitées et routées vers n'importe quelle destination configurée. Elle est souvent utilisée pour des cas d'utilisation server-to-server.

Pour gérer les utilisateurs, consultez plutôt le User API, et pour les produits, le Product API.

Endpoint URL

Le endpoint collect de l'API est disponible à l'URL suivante :

https://collect.commander1.com/events?tc_s={siteId}&token={sourceKey}

Méthode HTTP : POST

Paramètres

• tc_s (requis) : site id

• token (requis) : source key

La source key est affichée dans les paramètres de tout source.

En-têtes

Type de contenu

Le endpoint nécessite un Content-Type en-tête défini sur application/json:

Content-Type: application/json

Payload

Les propriétés de l'événement doivent être fournies dans le corps de la requête au format JSON.

Trouvez des détails sur les meilleures pratiques de nommage d'events ainsi que la événement méthode payload dans notre spécifications.

Le format du payload a évolué en nov. 2022. L'ancien format restera supporté pendant un an. Plus d’informations ici.

Les horodatages doivent être en millisecondes (ms).

consistent_anonymous_id correspond à un identifiant unique pour un utilisateur, utilisé sur la plateforme CAX pour identifier un utilisateur. C'est l'équivalent du cookie CAID sur une source Web.

Erreurs

Le endpoint renvoie une réponse HTTP 200 à toutes les requêtes API. Ainsi, le débogage doit être effectué via l'interface de la plateforme ou notre config API (event inspector ou event delivery API).

Exceptionnellement, un code HTTP 400 est renvoyé si la requête est trop volumineuse ou si le JSON du payload est invalide.

Taille maximale de la requête

Il y a un maximum de 32KB par requête API.

La batch L'endpoint API accepte un maximum de 500KB par requête, avec une limite de 32KB par événement dans le batch.

Limite de débit

Il n'existe pas de véritable limite de débit au-delà de laquelle le système rejetterait vos données. Mais si vous devez importer à un rythme supérieur à 500 requests per second, veuillez contact us au préalable.

Exemple

Exemple d'une requête API :

POST https://collect.commander1.com/events?tc_s=29&token=7183b9d4-1031-11ee-be56-0242ac120002

{
  "event_name": "search",
  "search_term": "t-shirts",
  "user": {
    "id": "12345",
    "consistent_anonymous_id": "67892",
    "email": "[email protected]",
    "consent_categories": [
      "1",
      "3"
    ]
  },
  "context": {
    "event_id": "202110130000000000",
    "page": {
      "title": "Search page",
      "url": "https://shop.com/search?q=...",
      "lang": "en",
      "referrer": "https://www.google.fr",
      "viewport": {
        "width": 320,
        "height": 568
      }
    },
    "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",
      "lang": "fr",
      "cookie": "_fbp=123; _fbc=456; _ga=789",
      "timezone": "Europe/Paris"
    },
    "event_timestamp": "1639044446636"
  }
}

OpenAPI Specification

Télécharger la spécification OpenAPI :

5KB

http_tracking_api_spec.yaml

Ouvrir

Sécurité et authentification

Notre API fonctionne via HTTPS, une norme pour les communications sécurisées sur Internet. Ce protocole garantit que les données sont chiffrées et transmises de manière sécurisée.

En complément de HTTPS, nous utilisons un système d'authentification par token API. Chaque source créée se voit attribuer un token unique qui reste le même pour toutes les requêtes API de cette source spécifique. Cette conception offre à la fois sécurité et commodité, permettant aux clients de gérer plusieurs sources chacune avec son token dédié. La possibilité pour les clients de créer, gérer et désactiver des sources via notre interface ajoute une couche de contrôle supplémentaire, garantissant que les tokens peuvent être invalidés si nécessaire pour des raisons de sécurité ou opérationnelles. Notre approche de sécurité est adaptée aux besoins diversifiés de nos clients. Nous nous concentrons sur la fourniture d'une expérience sécurisée, efficace et conviviale. Notre choix de HTTPS et d'une authentification par token est conforme à notre engagement à fournir une sécurité robuste tout en assurant une intégration facile et une flexibilité opérationnelle pour nos clients. Cette approche est préférée à des systèmes plus complexes comme Mutual TLS (mTLS), OpenID Connect (OIDC) ou le filtrage IP.

Batch

La batch la méthode vous permet d'envoyer une série de événement requêtes dans un seul batch, économisant ainsi des requêtes sortantes.

Il y a un maximum de 500KB par requête batch et 32KB par appel.

Le endpoint collect du BATCH API est disponible à l'URL suivante :

https://collect.commander1.com/events/batch?tc_s={siteId}&token={sourceKey}

Exemple de Batch

Exemple d'une requête API :

POST https://collect.commander1.com/events/batch?tc_s=29&token=7183b9d4-1031-11ee-be56-0242ac120002

{
  "batch": [
      {
        "event_name": "add_payment_info",
        "payment_method": "card",
        "revenue": 16.00,
        "value": 22.53,
        "currency": "EUR",
        "user": {
            "id": "12345",
            "consistent_anonymous_id": "67892",
            "consent_categories": [1,3]
        },
        "context": {
          "event_id": "202210310000000000",
          "page": {},
          "device": {}
        },
        "event_timestamp": "1639044446636"
      },
      {
        "event_name": "generate_lead",
        "method": "LinkedIn",
        "user": {
            "consistent_anonymous_id": "5689865"
            "consent_categories": [1,2,3]
        },
        "context": {
          "event_id": "202210180000000000",
          "page": {},
          "device": {}
        },
        "event_timestamp": "1639094446633"
      }
  ]
}