s²low 1.2.1 api helios

S²LOW 1.2.1
API HELIOS
20/03/2012
Table des matières
1 Transactions Collectivité vers la pairie.............................................................................................3
1.1 Déposer un flux XML...............................................................................................................3
1.2 Récupérer le statut d'une transaction........................................................................................3
1.3 Récupérer le fichier XML ACK/NACK ..................................................................................4
2 Transactions DGFiP vers collectivités (Flux retours).......................................................................4
2.1 Obtenir la liste des flux retours non lus....................................................................................4
2.2 Récupérer un PES RETOUR....................................................................................................5
2.3 Changer le statut du flux PES RETOUR..................................................................................5
Objet : ce document décrit l'API HTTP permettant d'accéder via un programme au module HELIOS
du logiciel S²low.
Tous les chemins de scripts indiqués par la suite sont relatifs à l'adresse de base du serveur (qui est
de la forme https://nom.du.serveur/).
20/03/2012
1 Transactions Collectivité vers la pairie
1.1 Déposer un flux XML
Nom du script : /modules/helios/api/helios_importer_fichier.php
Méthode HTTP d'appel : POST avec enctype="multipart/form-data
Description : Soumission d'un fichier XML représentant le document à transmettre à la
pairie de la collectivité.
La plate-forme se charge de contrôler l'unicité du fichier déposé et de le déposer sur le
serveur de la DGFiP.
Paramètre du script :
Nom paramètre
Présence
Format
Description
enveloppe
obligatoire
Fichier attaché Fichier XML contenant les données
comptables
signature
optionnelle
Fichier attaché Fichier PKCS#7 contenant la
signature
Retour : fichier XML
<import>
<id> numéro de la transaction crée </id>
<resultat> OK ou KO </resultat>
<message> message complémentaire </message>
</import>
Information : La création d'une transaction avec une signature invalide retournera dans un
premier temps OK mais le statut changera immédiatement par la suite pour passer en
erreur, soit -1.
1.2 Récupérer le statut d'une transaction
Nom du script : /modules/helios/api/helios_transac_get_status.php
Méthode HTTP d'appel : GET
Description : Avec l'id d'une transaction, on peut connaître son statut.
Paramètre du script :
Nom paramètre
Présence
Format
transaction
obligatoire
Entier
Description
id de la transaction
20/03/2012
Retour : fichier XML
<transaction>
<id> numéro de la transaction </id>
<resultat> OK ou KO </resultat>
<status> status </status>
<message> message complémentaire </message>
</transaction>
Liste des statuts :
– -1 : Erreur
– 1 :posté
– 2 :En attente de transmission
– 3 : Transmis
– 4 :Ack
– 6 :Nack
– 7 :En traitement
– 8 : Informations disponible (pour les PES_ACK format mis en place par le DGFiP
début 2012)
1.3 Récupérer le fichier XML ACK/NACK
Nom du script : /modules/helios/helios_download_acquit.php
Méthode HTTP d'appel : GET
Description : Ceci permet de télécharger le fichier récupérer sur les serveurs de la DGFiP.
Celui-ci contient l'acquittement ou le rejet de la transaction concernée.
Paramètre du script :
Nom paramètre
Présence
Format
id
obligatoire
Entier
Description
id de la transaction
Retour : fichier XML d'acquittement ou de non acquittement retourné par le DGFiP.
2 Transactions DGFiP vers collectivités (Flux retours)
2.1 Obtenir la liste des flux retours non lus
Nom du script : /modules/helios/api/helios_get_list.php
20/03/2012
Méthode HTTP d'appel : GET
Description : La DGFiP a la possibilité d'envoyer aux collectivités des flus XML. Ils sont
nommés Flux retours. Un fichier récupéré sur les serveurs de la DGFiP sont marqués
comme « non lu ». Cette API fournie la liste des flux retours, de la collectivité, déclarés
comme « non lu ».
Paramètre du script : aucun
Retour : fichier XML
<liste>
<idColl> identifiant de la collectivité</idColl>
<dateDemande> date de demande de la liste </dateDemande>
<resultat> OK ou KO </resultat>
<message> message complémentaire </message>
<pes_retour>
<id> identifiant du pes_retour </id>
<nom> nom </nom>
<date> date de réception du pes_retour par le tdt </date>
</pes_retour>
<pes_retour>
<id> identifiant du pes_retour </id>
<nom> nom </nom>
<date> date de réception du pes_retour par le tdt </date>
</pes_retour>
...
</liste>
2.2 Récupérer un PES RETOUR
Nom du script : /modules/helios/helios_get_retour.php
Méthode HTTP d'appel : GET
Description : Chaque flux retour est remarquable via id. Avec ce paramètre il est possible
de récupérer le fichier XML télé-transmis par la DGFiP à l'attention de la collectivité.
Paramètre du script :
Nom paramètre
Présence
Format
id
obligatoire
Entier
Description
id du fichier
Retour : fichier XML de la pairie
2.3 Changer le statut du flux PES RETOUR
Nom du script : /modules/helios/api/helios_change_status.php
20/03/2012
Méthode HTTP d'appel : GET
Description : Chaque flux retour est remarquable via id. Avec ce paramètre il est possible
de modifier l'état de la transaction pour la passer de « non lu » à « lu ».
Paramètre du script :
Nom paramètre
Présence
Format
id
obligatoire
Entier
Description
id de la transaction
Retour : fichier XML
<change>
<id> numéro de la transaction </id>
<resultat> OK ou KO </resultat>
<message> message complémentaire </message>
</change>
20/03/2012