Historique de la page

Sommaire

Paramétrage

Le connecteur CMS a été pensé de manière à pouvoir s'interfacer avec plusieurs CMS. Actuellement, 2 modules permettent de communiquer avec Wordpress et Directus.

La configuration du CMS qui sera utilisé se fait au niveau du fichier .env

Bloc de code

language	yaml

# CMS TO USE : directus | wordpress
DEFAULT_CMS=

# DIRECTUS
#DIRECTUS_API_URL=xxx
#DIRECTUS_API_TOKEN=xxx
#DIRECTUS_API_TIMEOUT=5000
# WORDPRESS
#WORDPRESS_API_URL=xxx
#WORDPRESS_API_USERNAME=xxx
#WORDPRESS_API_PASSWORD=xxx
#WORDPRESS_API_TIMEOUT=5000

Dans DEFAULT_CMS indiquez le CMS souhaité, puis dé-commentez les lignes de conf propres au CMS choisi.

Sécurité

Le connecteur requiert une authentification JWT HS256 de la part du backend de Multi.

Définir une clé JWT privée dans le fichier .env au niveau de l'attribut TOKEN_SECRET, puis générez un bearer token à partir de cette clé.
Ce bearer token sera ensuite à placer dans le fichier .env des microservices nécessitant un accès aux données du CMS au niveau de la variable se terminant par _SERVICE_CMS_CONNECTOR_API_BEARER_TOKEN (ex: auth, contact-us, features, important-news, ...)

Info

Il est tout à fait possible de générer un bearer token différent par microservice. Ce qui pourrait permettre d'identifier plus tard dans les logs du connecteur quel microservice a effectué quelle requête via l'analyse du payload

Bloc de code

language	json
title	Exemple de payload

{
  "service": "important-news",
  "iss": "multi-cms-connector"
}

Routes disponibles

Le connecteur CMS expose plusieurs routes :

Une route /graphql pour les requêtes GraphQL
Une route GET /health, publique, permettant de retourner l'état de l'application, pour le monitoring
Une route GET /cache/clear/features, permettant de vider le cache pour les features
Une route GET /cache/clear/contact-us, permettant de vider le cache pour contact-us
Une route GET /cache/clear/login, permettant de vider le cache pour login
Une route GET /cache/clear/important-news, permettant de vider le cache pour les important-news
Une route GET /cache/clear/channels, permettant de vider le cache pour les channels
Une route GET /cache/clear/social-networks, permettant de vider le cache pour les social-networks
Une route GET /cache/clear/static-pages, permettant de vider le cache pour les static-pages
Une route GET /cache/clear/widgets, permettant de vider le cache pour les widgets
Une route GET /cache/clear/map-points, permettant de vider le cache pour les données de carte (map-points, map-categories, map-icons et campuses)
Une route GET /cache/clear-all, permettant de vider l'ensemble du cache

Toutes ces routes sont protégées par l'authentification JWT, exceptée celle pour le healthcheck

Collections et leurs champs disponibles via GraphQL

Channels

Bloc de code

language	graphql
title	Toutes les instances de la collection
collapse	true

query {
  channels {
    id
    code
    color
    icon
    routerLink
    filterable
    translations {
        languagesCode
        label
    }
  }
}

Bloc de code

language	graphql
title	Récupérer une instance de la collection
collapse	true

query {
  channel(id: "1") {
    id
    code
    color
    icon
    routerLink
    filterable
    translations {
        languagesCode
        label
    }
  }
}

Bloc de code

language	json
title	Exemple de réponse
collapse	true

{
    "data": {
        "channel": {
            "id": "1",
            "code": "ALERT",
            "color": "#EF154E",
            "icon": null,
            "routerLink": null,
            "filterable": false,
            "translations": [
                {
                    "languagesCode": "en",
                    "label": "ALERT"
                },
                {
                    "languagesCode": "fr",
                    "label": "ALERTE"
                }
            ]
        }
    }
}

Contact Us

Bloc de code

language	graphql
title	Instance Singleton
collapse	true

query {
  contactUs {
    icon
    to
    translations {
        languagesCode
        title
        content
    }
  }
}

Bloc de code

language	json
title	Exemple de réponse
collapse	true

{
    "data": {
        "contactUs": {
            "icon": "mail",
            "to": "test@test.com",
            "translations": [
                {
                    "languagesCode": "fr",
                    "title": "Nous contacter",
                    "content": "<p>On peut tromper 1000 fois 1 personne, mais on ne peut pas tromper 1000 fois 1000 personnes</p>"
                },
                {
                    "languagesCode": "en",
                    "title": "Contact us",
                    "content": "<p>You can fool 1 person 1000 times, but you can't fool 1000 people 1000 times</p>"
                }
            ]
        }
    }
}

Features

Bloc de code

language	graphql
title	Toutes les instances de la collection
collapse	true

query {
  features {
    id
    description
    translations {
        languagesCode
        title
        shortTitle
        searchKeywords
    }
    icon
    iconSvgDark
    iconSvgLight
    menu
    authorization {
        roles
        type
    }
    position
    settingsByRole {
        position
        role
    }
    type
    routerLink
    link
    ssoService
    statisticName
  }
}

Bloc de code

language	graphql
title	Récupérer une instance de la collection
collapse	true

query {
  feature(id: "1") {
    id
    description
    translations {
        languagesCode
        title
        shortTitle
        searchKeywords
    }
    icon
    iconSvgDark
    iconSvgLight
    menu
    authorization {
        roles
        type
    }
    position
    settingsByRole {
        position
        role
    }
    type
    routerLink
    link
    ssoService
    statisticName
  }
}

Bloc de code

language	json
title	Exemple de réponse
collapse	true

{
    "data": {
        "feature": {
            "id": "1",
            "description": "Redirige l'utilisateur vers le service interne affichant les dernières actualités",
            "translations": [
                {
                    "languagesCode": "fr",
                    "title": "L'actualité",
                    "shortTitle": null,
                    "searchKeywords": null
                },
                {
                    "languagesCode": "en",
                    "title": "News",
                    "shortTitle": null,
                    "searchKeywords": null
                }
            ],
            "icon": null,
            "iconSvgDark": "<svg width=\"14\" height=\"14\" viewBox=\"0 0 14 14\" xmlns=\"http://www.w3.org/2000/svg\">...</svg>",
            "menu": "top",
            "authorization": null,
            "position": 10,
            "settingsByRole": [
                {
                    "position": 1,
                    "role": "student"
                }
            ],
            "type": "internal",
            "routerLink": "/rss",
            "link": null,
            "ssoService": null,
            "statisticName": "rss"
        }
    }
}

Important News

Bloc de code

language	graphql
title	Toutes les instances de la collection
collapse	true

query {
  importantNews {
    id
    translations {
        languagesCode
        title
        content
        buttonLabel
    }
    image
    authorization {
        roles
        type
    }
    color
    link
    statisticName
  }
}

Bloc de code

language	graphql
title	Récupérer une instance de la collection
collapse	true

query {
  importantNew(id: "1") {
    id
    translations {
        languagesCode
        title
        content
        buttonLabel
    }
    image
    authorization {
        roles
        type
    }
    color
    link
    statisticName
  }
}

Bloc de code

language	json
title	Exemple de réponse
collapse	true

{
    "data": {
        "importantNew": {
            "id": "1",
            "translations": [
                {
                    "languagesCode": "fr",
                    "title": "Cartes étudiant",
                    "content": "Vos cartes d'étudiant sont disponibles !",
                    "buttonLabel": "Voir vos cartes"
                },
                {
                    "languagesCode": "en",
                    "title": "Student cards",
                    "content": "Your student cards are available!",
                    "buttonLabel": "See your cards"
                }
            ],
            "image": "5a3695fc-af24-4c60-bd67-50eaee02d81e",
            "authorization": {
                "roles": [
                    "student"
                ],
                "type": "ALLOW"
            },
            "color": "#EF154E",
            "link": "/cards",
            "statisticName": "cards"
        }
    }
}

Bloc de code

language	graphql
title	Instance Singleton
collapse	true

query {
  login {
    translations {
        languagesCode
        notAuthenticatedText
        connectionText
    }
  }
}

Bloc de code

language	json
title	Exemple de réponse
collapse	true

{
    "data": {
        "login": {
            "translations": [
                {
                    "languagesCode": "fr",
                    "notAuthenticatedText": "Vous n'êtes pas authentifié",
                    "connectionText": "<p>Bonjour</p>"
                },
                {
                    "languagesCode": "en",
                    "notAuthenticatedText": "You are not authenticated",
                    "connectionText": "<p>Welcome</p>"
                }
            ]
        }
    }
}

Social Networks

Bloc de code

language	graphql
title	Toutes les instances de la collection
collapse	true

query {
  socialNetworks {
    id
    title
    icon
    link
    position
  }
}

Bloc de code

language	graphql
title	Récupérer une instance de la collection
collapse	true

query {
  socialNetwork(id: "1") {
    id
    title
    icon
    link
    position
  }
}

Bloc de code

language	json
title	Exemple de réponse
collapse	true

{
    "data": {
        "socialNetwork": {
            "id": "1",
            "title": "github",
            "icon": "logo-github",
            "link": "https://github.com/EsupPortail",
            "position": 1
        }
    }
}

Static Pages

Bloc de code

language	graphql
title	Toutes les instances de la collection
collapse	true

query {
  staticPages {
    id
    translations {
        languagesCode
        title
        content
    }
    icon
    iconSvgDark
    iconSvgLight
    position
    statisticName
  }
}

Bloc de code

language	graphql
title	Récupérer une instance de la collection
collapse	true

query {
  staticPage(id: "1") {
    id
    translations

Paramètres d'appels

URL en méthode POST

Bloc de code
<host>/graphql

host : adresse du serveur

Header de la requête :

Bloc de code
{ "Content-Type": application/json }

Body des requêtes :

Bloc de code

title	Channels

query {
	channels{
        id
        code
        routerLink
        icon
        color
        filterable
        translations{
        languagesCode
    languagesCode
    title
        labelcontent
    }
    }icon
    }
}

Bloc de code

title	Contact Us

query {
	contactUs{
iconSvgDark
    iconSvgLight
    idposition
        tostatisticName
  }
}

Bloc de code

language	json
title	Exemple de réponse
collapse	true

{
    "data": {
   icon
        translations"staticPage": {
            languagesCode
"id": "1",
            "translations": content[
            title
        }{
    }
}

Bloc de code

title	Features

query {
	features(status: "published") {
        id
        description
"languagesCode": "fr",
           icon
          iconSvgDark
 "title": "Aide",
       iconSvgLight
        link
     "content": "<h2>Bonjour  menu!</h2>\n<p>Lorem ...</p>"
        position
        routerLink},
        ssoService
        status{
        type
        translations{
     "languagesCode": "en",
      languagesCode
            searchKeywords
  "title": "Help",
                 shortTitle
       "content": "<h2>Hello !</h2>\n<p>Lorem ...</p>"
        title
        }
           authorization {],
            roles"icon": "help-circle-outline",
            authorization"iconSvgDark": null,
        }
        settingsByRole{"iconSvgLight": null,
            "position": 1,
            role"statisticName": "help"
        }
    }
}

Widgets

Bloc de code

language	graphql
title	Toutes les instances de la collection
collapse	true

Bloc de code

title	Pages

query {
	pages(status: "published")  widgets {
    id
    iddescription
    widget
    translations status{
        iconlanguagesCode
        iconSvgDarktitle
        iconSvgLightcontent
    }
    positionicon
    iconSvgDark
    statisticNameiconSvgLight
    authorization    translations {
            languagesCoderoles
        type
    content}
    position
    settingsByRole    title{
        }position
     }
}

Bloc de code

title	Widgets

query {
	widgets(status: "published") {role
    }
    id
		statustype
    routerLink
    descriptionlink
    ssoService
    widgetcolor
    statisticName
  }
}

Bloc de code

language	graphql
title	Récupérer une instance de la collection
collapse	true

query {   iconSvgDark
  widget(id: "1") {
    iconSvgLightid
    description
    iconwidget
    translations    link{
        positionlanguagesCode
        ssoService
		statisticNametitle
        routerLinkcontent
    }
    coloricon
    iconSvgDark
    typeiconSvgLight
      authorization  translations{
            languagesCoderoles
        type
    content}
    position
    settingsByRole {
   title
     position
   }
     role
   authorization {}
    type
    routerLink
    roleslink
    ssoService
    color
    authorizationstatisticName
  }
}

Bloc de code

language	json
title	Exemple de réponse
collapse	true

{
    "data": {
 }
       "widget": settingsByRole{
             position"id": "1",
            role
        }"description": "Widget affichant les prochains événements dans le calendrier",
    }
}

Bloc de code

title	Social Networks

query {
	socialNetworks{
        id"widget": "calendar:calendar",
        icon
        link
     "translations": [
   title
    }
}

Bloc de code

title	Login

query {
	login{
        id{
        translations {
            languagesCode"languagesCode": "en",
            connexionText
        "title": "Your next  notAuthenticatedTextevents",
        }
    }
}

Bloc de code

title	Languages

query {
	languages{
       "content": codenull
        direction
        name},
      }
}

Bloc de code

title	Important News

query {
	importantNews(status: "published"){
        id{
        status
        image
    "languagesCode": "fr",
    link
        color
        position
   "title": "Vos prochains évènements",
     statisticName
        translations{
       "content": null
    languagesCode
            content}
            buttonLabel],
             title"icon": null,
        }
    "iconSvgDark": null,
   authorization {
            roles"iconSvgLight": null,
            "authorization
    ": {
    }
    }
}

Format de retour

Format attendu

Code HTTP 200 : si tout s'est bien passé

Cas d'erreur

Erreur HTTP 4xx ou 5xx : En cas de problème ou erreur

Exemple

Bloc de code

title	URL en méthode POST

<host>/graphql

Bloc de code

title	Body de la requête

query {
	languages{
       "roles": code[
        direction
        name
    }
}

Bloc de code

title	Réponse

{
"anonymous"
      "data": {
        "languages": [
 ],
                {
"type": "DISALLOW"
            },
            "codeposition": "fr"50,
                "directionsettingsByRole": "ltr"[],
                "nametype": "Françaisexternal",
            "routerLink": }null,
            "link": "https://mail.mon-univ.fr/zimbra/preauth/preauthUL_ETU.jsp?ticket={st}",
                "codessoService": "enhttps://mail.mon-univ.fr/zimbra/preauth/preauthUL_ETU.jsp",
                "directioncolor": "ltr"null,
                "namestatisticName": "English"
    null
        }
        ]
    }
}

Arborescence des pages

Comparaison des versions

Ancienne version 3

Nouvelle version Actuel

Légende

Sommaire

Paramétrage

Sécurité

Routes disponibles

Collections et leurs champs disponibles via GraphQL

Channels

Contact Us

Features

Important News

Social Networks

Static Pages

Paramètres d'appels

Widgets

Format de retour

Format attendu

Cas d'erreur

Exemple

Arborescence des pages

Pages … Accueil Connecteurs Connecteur CMS Headless Historique de la page

Comparaison des versions

Ancienne version 3

Nouvelle version Actuel

Légende

Sommaire

Paramétrage

Sécurité

Routes disponibles

Collections et leurs champs disponibles via GraphQL

Channels

Contact Us

Features

Important News

Login

Social Networks

Static Pages

Paramètres d'appels

Widgets

Format de retour

Format attendu

Cas d'erreur

Exemple

Pages

Accueil
Connecteurs
Connecteur CMS Headless

Historique de la page