Comment passer à la nouvelle version de notre API de collecte ?

Si vous utilisiez jusqu’à présent l’ancienne version de notre API pour nous transmettre vos commandes et collecter des avis clients, sachez qu’une nouvelle version, plus performante, est désormais disponible.

Pourquoi passer à la nouvelle version ?

  • L’ancienne API sera prochainement désactivée : pour continuer à collecter vos avis sans interruption, il est essentiel de migrer vers la nouvelle version dans les prochains mois.
  • Des performances techniques améliorées.
  • Des écrans de configuration repensés : la configuration de la collecte est plus intuitive et accessible.
  • Une nouvelle page de suivi des envois : visualisez facilement l’état de vos demandes d’avis.
  • Une gestion autonome des emails de sollicitation : vous avez davantage de flexibilité pour personnaliser vos envois et adapter votre stratégie de collecte.

Comment vérifier la version de l’API que vous utilisez ?

Consultez les écrans ci-dessous et comparez les au menu de votre compte Avis Vérifiés :

✨ Nouvelle Version API 🖥️ Version historique API

Une fois la migration réalisée, l’historique de suivi des demandes d'avis lié à l’ancienne API ne sera plus accessible. Pensez donc à exporter les données si besoin.

La nouvelle API ne permet pas d’exclure certains produits de la collecte d’avis.

Mise en place de la nouvelle API

Suivez les étapes ci-dessous :

  1. Tout d'abord, contactez nos équipes : des manipulations techniques doivent d'abord être réalisées de notre côté.

  2. Une fois la validation de nos équipes obtenue, il est impératif de désactiver l’appel à l’ancienne API. Cela permet d’éviter les doublons de transfert de commandes et évitera de solliciter vos consommateurs à deux reprises. 

  3. Une fois les nouvelles pages de configuration disponibles dans votre espace Avis Vérifiés, vous pourrez vous rendre dans le menu latéral gauche d Collecte des avis, puis Configuration  

  4. Choisissez alors API dans le bandeau de configuration 

  5. Cliquez sur le bouton vous permettant de  créer votre compte API 

  6. Une fois le compte créé, vous pouvez visualiser vos paramètres API : URL, identifiant et clé secrète

  7. Générez alors votre clé secrète en cliquant sur Voir la clé

En cas de problème, vous pourrez à nouveau générer cette clé.

Structurer et envoyer la requête  

Authentification

L'API Skeepers utilise OpenId Connect Client Credential grant pour authentifier les requêtes. Dans cette autorisation, un utilisateur spécifique n'est pas autorisé, mais plutôt les informations d'identification sont vérifiées et un access_token générique est renvoyé.

Cette autorisation (OpenId Connect Client Credential grant) est utilisée pour l'authentification de machine à machine.

Authentification URL

https://auth.skeepers.io/realms/skeepers/protocol/openid-connect/token

Header Parameter
  • Authorization: Set to Basic <base64 encoded "clientId:clientSecret">
  • Content-Type: Set to application/x-www-form-urlencoded
Request Parameter
  • grant_type: Set to client_credentials
  • scope: Set to openid
Exemple

POST https://auth.skeepers.io/realms/skeepers/protocol/openid-connect/token HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Authorization: Basic <base64 encoded "clientId:clientSecret">

grant_type="client_credentials" & scope="openid"
      
Purchase Event API Swagger

Veuillez cliquer sur ce lien (Swagger) afin d’avoir accès au guide pour paramétrer et simuler vos requêtes de preuves d’achat ou prestation de service.

C'est ici, dans la partie Authentication que vous devrez ajouter l'identifiant de votre site web :

Retrouver les codes d'intégration 

Pour retrouver votre clé secrète et l'identifiant de votre site web :

  1. Rendez-vous dans le menu latéral gauche d'Avis Vérifiés Gestion du compte, puis Mon compte.
  2. Les informations se trouvent alors à droite de la page dans la partie Code d'intégration.

Suivre la collecte

Vous disposez désormais de la nouvelle page de suivi de votre collecte. Celle-ci vous permettra de vérifier la transmission et l'intégration de vos preuves d’achat/service ainsi que l'état de la demande d'avis.

Pour cela, rendez-vous dans le menu latéral gauche  Collecte des avis, puis Suivi des demandes d'avis

Si vous souhaitez récolter uniquement des avis marque, vous devez retirer la variable produit de votre appel API.

Personnaliser vos emails

La nouvelle version de notre API vous permet d'utiliser le configurateur d'emails, et donc de personnaliser vos demandes d'avis pour booster votre collecte !

Nous vous invitons à contacter nos équipes afin de discuter de sa mise en place.

Cet article vous a-t-il été utile ?
Utilisateurs qui ont trouvé cela utile : 0 sur 0