Version du 31 octobre 2016 à 12:51

Présentation

L'objet de cette page est de décrire la récupération des vols par un logiciel tiers. La récupération est réalisée à l'aide d'un service web.

Interfaçage avec OpenFlyers

La récupération des X derniers vols se fait à l'aide du webservice getActivityList.

Pour accéder à ce webservice, il faut :

• Utiliser le protocole de communication HTTPS
• Appeler l'URL ci-dessous en remplaçant "maplateforme" par le nom de la plateforme concernée :

https://maplateforme.openflyers.fr/actionOnDemand.php

• Transmettre les paramètres suivantes par méthode POST :
  • arguments[0] : getActivityList
  • key : La clé de sécurité du service web.
  • maxNumber : Le nombre de vols à récupérer
  • startDate : La date de début en UTC des vols à récupérer. Ce paramètre est optionnel et doit être au format AAAA-MM-JJ hh:mm:ss
  • endDate : La date de fin des en UTC vols à récupérer. Ce paramètre est optionnel et doit être au format AAAA-MM-JJ hh:mm:ss

Le service web va renvoyer soit :

• Un message d'interdiction d'accès lorsque l'un de ces conditions est rencontrée :
  • le protocole de communication HTTP est employé
  • la clé de sécurité n'est pas bonne
  • La date de début est renseignée et la date de fin de l'est pas. Une date de début/fin qui n'est pas au bon format sera remplacée par la date courante
  • La date de fin est renseignée et la date de début ne l'est pas. Une date de début/fin qui n'est pas au bon format sera remplacée par la date courante
  • La date de début et de fin sont toutes les deux renseignées et il y a un écart de plus de 32 jours entre ces dates
• Au format JSON :
  • Lorsque startDate et endDate sont renseignés, la liste des vols entre ces périodes, ordonnés du plus récent au plus vieux
  • Le cas échéant, la liste des maxNumber derniers vols ordonnés du plus récent au plus vieux

Exemple de formulaire pour récupérer les derniers vols sur la plateforme demo-fr.openflyers.fr où on demande la clé et le nombre de vols :

<form action="https://demo-fr.openflyers.fr/actionOnDemand.php" method="post">
    <input type="hidden" name="arguments[0]" value="getActivityList" />
    <label>Clé :</label>
    <br/>
    <input type="text" name="key" value="" />
    <br/>
    <label>Limite :</label>
    <br/>
    <input type="text" name="maxNumber" value="1" />
    <br/>
    <label>Date de début (AAAA-MM-JJ hh:mm:ss) :</label>
    <br/>
    <input type="text" name="startDate" value="" />
    <br/>
    <label>Date de fin (AAAA-MM-JJ hh:mm:ss) :</label>
    <br/>
    <input type="text" name="endDate" value="" />
    <br/>
    <input type="submit" value="Test" />
</form>

Exemple de de retour :

[
    {
        "first_person":"MUZIKA Joseph",
        "start_date":"2016-10-19 08:30:00",
        "second_person":"",
        "departure_location_name":"LFRB",
        "end_date":"2016-10-19 09:30:00",
        "arrival_location_name":"LFRB",
        "duration":"1:00",
        "landing_number":"2",
        "resource_name":"F-HIAE"
    },
    {
        "first_person":"OLLIVIER Gabriel",
        "start_date":"2016-10-18 15:16:00",
        "second_person":"",
        "departure_location_name":null,
        "end_date":"2016-10-18 16:46:00",
        "arrival_location_name":null,
        "duration":"1:30",
        "landing_number":"1",
        "resource_name":"Simu F-DSIM"
    }
]

Paramétrer la clé de sécurité

• Menu Admin > Configuration > Paramétrage
• Aller dans le bloc Gestion générale
• Saisir le champ Clé de service web (lorsque requis)