Migration des tableaux de bord Embedded Biwee v3 vers v4

Avec la sortie de Biwee v4, l'API d'intégration des tableaux de bord embarqués évolue : nouveaux endpoints, nouvelle méthode d'authentification et modification du format des requêtes/réponses. Ce document récapitule les changements majeurs et fournit des exemples et une checklist de migration pour mettre à jour votre implémentation.

La documentation de la nouvelle API de Biwee est disponible ici : https://api.biwee.fr/documentation/#tag/embedded-dashboard

Résumé des changements importants

• Le endpoint pour générer un token embarqué est désormais : POST https://api.biwee.fr/embed/GetToken

  • Obligatoire : sessionId et dashboardGuid.

• L'authentification nécessite désormais d'inclure votre clé API dans l'en-tête X-API-Key.

• Le endpoint GetToken retourne un objet JSON contenant le token dans la propriété tokenGuid.

• Le endpoint pour révoquer une session est désormais : GET https://api.biwee.fr/embed/Logout?sessionId=...

• Le endpoint pour l'appel IFrame est désormais : GET https://v4.biwee.fr/api/dashboard/{token}

Étapes de migration

1. Remplacer l'appel d'obtention de token précédent par un POST vers /embed/GetToken :

   • Mettre sessionId et dashboardGuid en query string (ex. ?sessionId=...&dashboardGuid=...).

   • Envoyer en body JSON les options supplémentaires (facultatives) :

     • connectionString (string, nullable)

     • user (string, nullable)

     • organization (string, nullable)

     • customInfo (string, nullable)

     • parameters (object) — p.ex. { "Param1": "Value1", "Param2": 123 }

   • Ajouter l'en-tête HTTP : X-API-Key: <votre_api_key>

   Pour plus de détails, consultez : https://api.biwee.fr/documentation/#tag/embedded-dashboard/post/embed/GetToken

2. Construire l'iframe avec le token reçu

• https://v4.biwee.fr/api/dashboard/{tokenGuid}

Exemple HTML

<iframe
  src="https://v4.biwee.fr/api/dashboard/RECEIVED_TOKEN_GUID"
  scrolling="no" style="width:100%; height:100%; border:none;">
</iframe>

1. Remplacer l'appel de déconnexion précédent par un GET vers /embed/Logout :

   • Mettre sessionId en query string (ex. ?sessionId=...).

   • Ajouter l'en-tête HTTP : X-API-Key: <votre_api_key>

   Pour plus de détails, consultez : https://api.biwee.fr/documentation/#tag/embedded-dashboard/get/embed/Logout

Récapitulatif rapide

• Mettre à jour l'appel token → POST /embed/GetToken?sessionId=...&dashboardGuid=...

• Envoyer X-API-Key dans l'entête

• Placer les options supplémentaires dans le body JSON

• Utiliser tokenGuid renvoyé dans l'iframe : https://www.biwee.fr/api/dashboard/{tokenGuid}

• Appeler /embed/Logout?sessionId=... pour révoquer les tokens si nécessaire

Tableau récapitulatif des endpoints

Fonction	Ancien endpoint	Nouveau endpoint
Obtenir le token	https://www.biwee.fr/Api/GetToken/apiKey/sessionId/dashboardGuid	https://api.biwee.fr/embed/GetToken?sessionId={sessionId}&dashboardGuid={dashboardGuid}
Appel de l'iframe	<iframe src="https://www.biwee.fr/Tdb/{token}" ...>	<iframe src="https://v4.biwee.fr/api/dashboard/{tokenGuid}" ...>
Logout	https://www.biwee.fr/api/logout/:apiKey/:sessionId	https://api.biwee.fr/embed/Logout?sessionId={sessionId}

Remarques

• Si vous passiez auparavant des paramètres SQL via query string, vous devez maintenant les passer dans le body JSON

• Le endpoint pour l'appel IFrame est temporairement https://v4.biwee.fr/api/Dashboard, il sera remplacé à terme par https://www.biwee.fr/api/Dashboard