File:Message_blocage_popup_opera.png and Récupération des vols par un logiciel tiers: Difference between pages

From Documentation de la solution web de gestion OpenFlyers
(Difference between pages)
Jump to navigation Jump to search
imported>Jcheng
No edit summary
 
 
Line 1: Line 1:
__TOC__
=Présentation=
L'objet de cette page est de décrire la récupération des [[Introduction#saisie-de-l'activité|vols]] par un logiciel tiers. La récupération est réalisée à l'aide d'un [[Wikipedia-fr:Service web|service web]].


C'est, par exemple, grâce à cette fonctionnalité que les livrets de progression électroniques [https://iflyinnovation.com/ iFly innovation] et [https://www.f-prog.com/ Flight Progress] s'interfacent avec OpenFlyers.
=Documentation pour les développeurs d'interfaçage avec OpenFlyers=
''La récupération des X derniers vols est ouverte pour n'importe quel logiciel. La documentation de ce chapitre est destinée aux éditeurs logiciels qui souhaitent s'interfacer avec OpenFlyers.''
La récupération des X derniers vols se fait à l'aide du webservice '''getActivityList'''.
Prérequis : [[#Paramétrer-la-clé-de-sécurité|initialiser la clé de sécurité]] à une valeur non vide. Il s'agit d'une phrase qui doit être la même dans la configuration d'OpenFlyers et dans le logiciel tiers récupérant les vols.
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 :
<pre>https://openflyers.com/maplateforme/actionOnDemand.php</pre>
* 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 (paramètre optionnel)
** '''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 renvoie une réponse au format JSON si :
* le protocole de communication HTTPS est employé
* la clé de sécurité est correcte
*'''startDate''' et '''endDate''' sont renseignés. Une date de début/fin qui n'est pas au bon format sera remplacée par la date courante
*L'écart entre '''startDate''' et '''endDate''' est '''inférieur à 32 jours'''
Sinon, un message d'interdiction d'accès est renvoyé.
La liste des vols renvoyée entre ces périodes est ordonnée du plus récent au plus vieux.
Si le paramètre '''maxNumber''' est transmis, seuls les '''maxNumber''' derniers vols sont renvoyés en commençant par le plus récent
Exemple de formulaire pour récupérer les derniers vols sur la plateforme openflyers.com/demo-fr où on demande la clé et le nombre de vols. Il est recommandé de remplacer les dates par le 1er jour du mois courant et le 1er jour du mois suivant :
<syntaxhighlight lang="html4Strict"><?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head><title>Test récupération des vols</title><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<body><form action="https://openflyers.com/demo-aero-club/actionOnDemand.php" method="post">
    <input type="hidden" name="arguments[0]" value="getActivityList" />
    <label>Clé :</label>
    <br/>
    <input type="text" name="key" value="cleopenflyers" />
    <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="2020-04-01 00:00:00" />
    <br/>
    <label>Date de fin (AAAA-MM-JJ hh:mm:ss) :</label>
    <br/>
    <input type="text" name="endDate" value="2020-05-01 00:00:00" />
    <br/>
    <input type="submit" value="Test" />
</form>
</body>
</html></syntaxhighlight>
Exemple de retour :
<syntaxhighlight lang="javascript">[
    {
        "flight_id":"41134",
        "first_person":"DURAND Jacques",
        "start_date":"2016-10-19 08:30:00",
        "second_person":"",
        "departure_location_name":"LFPG",
        "end_date":"2016-10-19 09:30:00",
        "arrival_location_name":"LFPG",
        "duration":"1:00",
        "landing_number":"2",
        "resource_name":"F-HABC"
    },
    {
        "flight_id":"41035",
        "first_person":"DUPONT Jean",
        "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":"F-HDEF"
    }
]</syntaxhighlight>
=[[Configuration#Clé-de-service-web-(lorsque-requis)|Paramétrer la clé de sécurité]]=

Latest revision as of 11:45, 29 August 2025

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.

C'est, par exemple, grâce à cette fonctionnalité que les livrets de progression électroniques iFly innovation et Flight Progress s'interfacent avec OpenFlyers.

Documentation pour les développeurs d'interfaçage avec OpenFlyers

La récupération des X derniers vols est ouverte pour n'importe quel logiciel. La documentation de ce chapitre est destinée aux éditeurs logiciels qui souhaitent s'interfacer avec OpenFlyers.


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


Prérequis : initialiser la clé de sécurité à une valeur non vide. Il s'agit d'une phrase qui doit être la même dans la configuration d'OpenFlyers et dans le logiciel tiers récupérant les vols.

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://openflyers.com/maplateforme/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 (paramètre optionnel)
    • 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 renvoie une réponse au format JSON si :

  • le protocole de communication HTTPS est employé
  • la clé de sécurité est correcte
  • startDate et endDate sont renseignés. Une date de début/fin qui n'est pas au bon format sera remplacée par la date courante
  • L'écart entre startDate et endDate est inférieur à 32 jours

Sinon, un message d'interdiction d'accès est renvoyé.

La liste des vols renvoyée entre ces périodes est ordonnée du plus récent au plus vieux.

Si le paramètre maxNumber est transmis, seuls les maxNumber derniers vols sont renvoyés en commençant par le plus récent


Exemple de formulaire pour récupérer les derniers vols sur la plateforme openflyers.com/demo-fr où on demande la clé et le nombre de vols. Il est recommandé de remplacer les dates par le 1er jour du mois courant et le 1er jour du mois suivant : 

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head><title>Test récupération des vols</title><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<body><form action="https://openflyers.com/demo-aero-club/actionOnDemand.php" method="post">
    <input type="hidden" name="arguments[0]" value="getActivityList" />
    <label>Clé :</label>
    <br/>
    <input type="text" name="key" value="cleopenflyers" />
    <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="2020-04-01 00:00:00" />
    <br/>
    <label>Date de fin (AAAA-MM-JJ hh:mm:ss) :</label>
    <br/>
    <input type="text" name="endDate" value="2020-05-01 00:00:00" />
    <br/>
    <input type="submit" value="Test" />
</form>
</body>
</html>

Exemple de retour : 

[
    {
        "flight_id":"41134",
        "first_person":"DURAND Jacques",
        "start_date":"2016-10-19 08:30:00",
        "second_person":"",
        "departure_location_name":"LFPG",
        "end_date":"2016-10-19 09:30:00",
        "arrival_location_name":"LFPG",
        "duration":"1:00",
        "landing_number":"2",
        "resource_name":"F-HABC"
    },
    {
        "flight_id":"41035",
        "first_person":"DUPONT Jean",
        "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":"F-HDEF"
    }
]

Paramétrer la clé de sécurité

File history

Click on a date/time to view the file as it appeared at that time.

Date/TimeThumbnailDimensionsUserComment
current16:15, 6 September 2024Thumbnail for version as of 16:15, 6 September 2024387 × 217 (7 KB)Maintenance script (talk | contribs)== Summary == Importing file

You cannot overwrite this file.

The following page uses this file:

Metadata

This file contains additional information, probably added from the digital camera or scanner used to create or digitize it.

If the file has been modified from its original state, some details may not fully reflect the modified file.

Retrieved from "https://doc4-fr.openflyers.com/index.php?title=File:Message_blocage_popup_opera.png&oldid=13752"