Utiliser notre code d'intégration universel (avec vidéo)


Logora peut être installé sur n'importe quel site en insérant le code natif JavaScript. La documentation ci-après est à destination des développeurs. Logora propose également une documentation personnalisée pour l'installation Wordpress.


L'installation en Javascript se fait en deux temps 

  1.  Insérer la synthèse des débats 
  2.  Insérer l'espace de débat

Avant de commencer 


  • Enregistrez votre site sur Logora en envoyant un mail de demande à contact@logora.fr. Nous vous fournirons l'accès à votre espace d'administration.
  • Vous devez avoir accès au code de votre site sur lequel vous installez Logora. 
  • Munissez-vous de votre nom d'application disponible sur votre espace d'administration dans l'onglet Paramètres > Général.
  • Autorisez les domaines sur lesquels vous désirez insérer le code Logora. Pour cela, rendez-vous sur votre espace d'administration dans l'onglet Paramètres > Général > Sécurité > Domaines autorisés. Par exemple, si le code inséré sur la page à l'URL https://exemple.com/article/exemple-article, ajoutez le domaine https://exemple.com (attention: ne pas mettre de barre oblique à la fin).
    Exemple : http://localhost:3000 , http://sous-domaine.exemple.com.  Important : l'ajout des domaines sur l'espace d'administration fonctionne comme un ajout de tag, n'oubliez pas d'appuyer sur "entrer" lors de l'insertion de vos URL. 

1. Installer la synthèse du débat 


Insérez le code Javascript de la synthèse à l'endroit où vous souhaitez voir apparaître la synthèse du débat. Ceci est un exemple de code Javascript qui charge et affiche la synthèse du débat en cours lié à votre article. Elle est à afficher sur votre page article.


Le conteneur logora_synthese est l'endroit où la synthèse est chargée.

Code standard à copier/coller et compléter :


<div class="logora_synthese" data-object-id="logora_config"></div>
<script>
    // Variables de configuration
    var logora_config = {
        shortname: "NOM_APPLICATION", // Nom d'application présent dans votre espace d'administration
        debate: {
            identifier: "PAGE_IDENTIFIER" // Identifiant unique de la page
        }
    };

    (function() {
        var d = document, s = d.createElement('script');
        s.src = 'https://api.logora.fr/synthese.js'; 
        (d.head || d.body).appendChild(s);
    })();
</script>


Variables de configuration


shortname (requis) : nom d'application fourni par Logora et présent dans votre espace d'administration à l'onglet Paramètres > Général.


debate.identifier (requis) : identifiant unique lié à la page. Cet identifiant doit être unique pour chaque page où est insérée la synthèse. Il permettra de récupérer le débat correspondant à la page. Par exemple, l'identifiant peut être l'ID dans votre base de données de l'article présent sur la page, ou un slug unique ('exemple-identifiant').


Le débat lié à la page doit ensuite être créé dans l'espace d'administration, en fournissant l'identifiant debate.identifier. Si aucun débat n'est créé avec cet identifiant, la synthèse ne s'affichera pas.


Les débat peuvent aussi être créés automatiquement au chargement de la synthèse, à partir des variables de configuration, sans passer par l'espace d'administration. Pour cela, voir Comment créer les débats automatiquement depuis la synthèse ?.


2. Installer l'espace de débat 


Contrairement à la synthèse, l'espace de débat est généralement inséré dans une page dédiée. Prenons l'exemple d'un site web disponible à l'adresse https://exemple.com. L'éditeur du site web souhaite accéder à l'espace de débat via l'adresse https://exemple.com/espace-debat. Voici les étapes à suivre pour insérer l'espace de débat :


1. Ajouter une page pour insérer l'espace de débat


Créez une page dédiée où sera inséré l'espace de débat. Cette page est disponible à l'adresse https://exemple.com/espace-debat. Le préfixe 'espace-debat' est le préfixe par défaut. Il est modifiable dans l'espace d'administration.


2. Insérer le code JavaScript et vos variables de configuration


Insérez le code Javascript du débat à l'endroit où vous souhaitez voir apparaître l'espace de débat. 

L'ID logora_app est l'endroit où l'espace de débat est chargé.

Code standard à copier/coller et compléter : 


<div id="logora_app"></div>
<script>
    // Variables de configuration
    var logora_config = {
        shortname: "NOM_APPLICATION" // Nom d'application présent dans votre espace d'administration
    };

    (function() {
        var d = document, s = d.createElement('script');
        s.src = 'https://api.logora.fr/debat.js';
        (d.head || d.body).appendChild(s);
    })();
</script>


Variables de configuration


shortname (requis) : nom d'application fourni par Logora et présent dans votre espace d'administration à l'onglet Paramètres > Général.


Les variables de configuration sont là aussi nécessaires pour adapter l'espace de débat à vos besoins. Voir l'article Variables de configuration JavaScript pour plus d'informations.


Vous verrez alors sur votre page la barre de navigation et le pied de page Logora, séparés par un espace vide.


3. Réécriture des URLs pour les routes de l'espace de débat


Utilisez la réécriture d'URL sur votre plateforme ou CMS pour que les chemins commençant par 'espace-debat/' (ou le préfixe que vous avez choisi) pointent vers la page où est inséré l'espace de débat.


Accédez à la page https://exemple.com/espace-debat/debats. Vous êtes sur la page d'accueil de l'espace de débat !


Pour modifier le préfixe et les chemins d'URLs des pages de l'espace de débat, rendez-vous sur Quelles sont les routes de l'espace de débat ?.


Il ne reste plus qu'à implémenter la connexion et personnaliser Logora pour lancer votre premier débat. 


Suivez ces prochaines étapes pour terminer l'installation et lancer votre premier débat :