esup-multi

Arborescence des pages

Comparaison des versions

Légende

  • Ces lignes ont été ajoutées. Ce mot a été ajouté.
  • Ces lignes ont été supprimées. Ce mot a été supprimé.
  • La mise en forme a été modifiée.

...

Bloc de code
languageyaml
# 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
languagejson
titleExemple 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 healthcheckDans DEFAULT_CMS indiquez le CMS souhaité, puis dé-commentez les lignes de conf propres au CMS choisi.

Collections et leurs champs disponibles via GraphQL

Channels

Bloc de code
languagegraphql
titleToutes les instances de la collection
collapsetrue
query {
  channels {
    id
    code
    color
    icon
    routerLink
    filterable
    translations {
        languagesCode
        label
    }
  }
}

...

Bloc de code
languagegraphql
titleToutes les instances de la collection
collapsetrue
query {
  importantNews {
    id
    translations {
        languagesCode
        title
        content
        buttonLabel
    }
    image
    authorization {
        roles
        type
    }
    color
    link
    position
    statisticName
  }
}
Bloc de code
languagegraphql
titleRécupérer une instance de la collection
collapsetrue
query {
  importantNew(id: "1") {
    id
    translations {
        languagesCode
        title
        content
        buttonLabel
    }
    image
    authorization {
        roles
        type
    }
    color
    link
    position
    statisticName
  }
}
Bloc de code
languagejson
titleExemple de réponse
collapsetrue
{
    "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",
            "position": null,
            "statisticName": "cards"
        }
    }
}

...