Skip to content
Snippets Groups Projects
Select Git revision
  • master default protected
  • release_3.0.0
  • test
  • feature_pre_sql
  • develop
  • 3.0.1
  • 3.0.0
  • 2.3.0
  • 2.2.0
  • 2.1.0
  • 2.0.0
  • 1.3.7
  • 1.3.6
  • 1.3.5
  • 1.3.4
  • 1.3.3
  • 1.3.2
  • 1.3.1
  • 1.3.0
  • 1.2.6
  • 1.2.5
  • 1.2.4
  • 1.2.3
  • 1.2.2
  • 1.2.1
25 results

sygal-import-ws

  • Clone with SSH
  • Clone with HTTPS
    • Name Last commit Last update
    config
    dist
    doc
    docker
    module
    public
    src/Apigility
    .dockerignore
    .gitignore
    .gitlab-ci.yml
    CHANGELOG.md
    Dockerfile
    Dockerfile.sh
    INSTALL.md
    LICENSE
    README.md
    bump-version
    composer.json
    composer.lock
    docker-compose.yml
    install.sh
    phpcs.xml
    phpunit.xml.dist
    README.md

    sygal-import-ws

    Que fait sygal-import-ws ?

    sygal-import-ws est un web service (ws) qui interroge les données présentes dans un SI (via des vues en base de données) et les met à disposition pour leur lecture via des requêtes GET.

    Technologies employées

    sygal-import-ws repose sur l'utilisation de :

    • Apigility pour la fourniture du ws ;
    • Doctrine pour la gestion de la partie BDD (notamment des schémas des tables).

    Installation

    Cf. INSTALL.md.

    Lancement du web service pour le dévelopement

    Solution 1 : le serveur interne PHP

    En phase de développement, la façon la plus simple consiste en l'utilisation du serveur interne de php :

    php -S 0.0.0.0:8080 -ddisplay_errors=0 -t public public/index.php

    Solution 2 : Docker

    Se placer à la racine des sources du ws pour lancer la commande suivante :

    docker-compose up -d --build

    Vérifier que le container sygal-import-ws-container figure bien dans la liste des containers lancés listés par la commande suivante (cf. colonne NAMES) :

    docker ps

    Le port sur lequel écoute le ws est indiqué dans la colonne PORTS. Par exemple, 0.0.0.0:443->8443/tcp indique que le ws est accessible sur la machine hôte à l'adresse https://localhost:8443.

    Les services fournis

    Chaque vue en base de données peut être interrogée via un service dédié :

    • /structure
    • /etablissement
    • /ecole-doctorale
    • /unite-recherche
    • /individu
    • /doctorant
    • /these
    • /these-annee-univ
    • /role
    • /acteur
    • /financement
    • /titre-acces
    • /variable

    Exemple :

    curl --insecure --header "Accept: application/json" --header "Authorization: Basic xxxx" https://localhost:8443/variable

    Remplacer xxxx par le token généré grâce à la commande suivante (le mot de passe est celui choisi lors de la commande htpasswd -c users.htpasswd sygal-app) :

    echo -n 'sygal-app:motdepasse' | base64

    Il se peut que vous soyez obligé de contourner le proxy en faisant ceci :

    export no_proxy=localhost

    L'interrogation d'un service sans paramètre va retourner l'intégralité des données concernées.

    Afin d'obtenir les informations spécifiques à une donnée, il est possible d'ajouter son identifiant, exemple :

    curl --insecure --header "Accept: application/json" --header "Authorization: Basic xxxx" https://localhost:8443/variable/ETB_LIB_NOM_RESP

    Pour mettre en forme le JSON retourné et faciliter la lecture, une solution est d'utiliser python -m json.tool:

    curl --insecure --header "Accept: application/json" --header "Authorization: Basic xxxx" https://localhost:8443/variable | python -m json.tool

    Remarques complémentaires

    • Le web service ne répond qu'aux requêtes de type GET.
    • Le web service retourne du json seulement.

    Service Acteur

    Ce service accepte un paramètre supplémentaire : un identifiant de thèse (source code) peut être spécifié pour obtenir les acteurs de cette seule thèse. Exemple :

    curl --insecure --header "Accept: application/json" --header "Authorization: Basic xxxxx" https://localhost:8443/acteur?these_id=13111