Fonctionnement

Le connecteur de sortie JSON permet de récupérer régulièrement l'ensemble des écritures comptables validées. Le connecteur met également à disposition les fichiers images permettent d'accéder aux pièces jointes.

Les écritures au format .json ainsi que les pièces jointes sont regroupées dans un fichier zip. Un fichier zip est généré a chaque période (par exemple chaque heure) sauf si aucune nouvelle facture n'est validée.
Ce fichier est accessible par une API .Il est également disponible pendant quelques jours dans l'interface graphique, au niveau de la configuration du connecteur.

Déclenchement de l'extraction

2 modes d'extraction sont possibles :

Manuellement : L'extraction est déclenchée à la demande (manuellement) directement par un bouton d'extraction sur le connecteur. Au moment du déclenchement, l'ensemble des factures au statut de connecteur "En cours" sont extraites.
Automatiquement : A intervalle régulier, l'ensemble des factures au statut de connecteur "En cours" sont extraites.

Configuration

Sécurité

Il est obligatoire d'utiliser la clé d'API afin d'authentifier les requêtes faites à Conciliator

Mise en oeuvre de l'API

Code de retour

200 OK: le fichier est transféré et aucun autre fichier n'est disponible
206 Partial Content: le fichier le plus ancien est transféré mais d'autres fichiers sont encore disponibles
403 Forbidden: le token n'est pas valide

Le nom du fichier ZIP est donné dans le header HTTP

Récupération sur erreur: le fichier reste disponible pour récuperation par l'API si le transfert est interrompu. Exemle de commande :

curl -OJH "Authorization: Bearer azerty123" <https://app.invoice.conciliator.ai/api/v0/json>

Exemple complet en Bash (Unix) :

**#!/bin/bash** 
BEARER=azerty123 
URL=https://app.invoice.conciliator.ai/api/v0/json
http_code=0 
**until** [ $http_code -**eq** 200 ]; **do** 
	http_code=$(curl -w "%{http_code}" -OJH "Authorization: Bearer $BEARER" $URL 2> /dev/null) 
	**if** [ $http_code -**ge** 300 ]; **then** 
		echo "Authentication or Server issue: $http_code" 1>&2 
		exit 1 
	**fi
done**

Nommage des fichiers de sortie

Les fichiers de sortie sont configurables sur la page du connecteur.

Fichier ZIP :

Chaque extraction génère un dossier compressé contenant un fichier au format JSON et, (si l'option est cochée) les factures au format PDF.

L'option "Insérer les factures pdf dans l'export" indique s'il faut insérer les factures au format pdf dans le dossier compressé générer.

Le nom du fichier zip est au format : conciliator-json_export-aaaa/mm/dd-hh-mm-ss.zip

ex: conciliator-json_export-2019-05-06-14-15-42.zip

Fichier d'écriture comptable :

Toutes les factures de l'export sont situé dans un fichier au format json.

Le nom du fichier est au format : json_aaaa-mm-dd.json

ex: json_export_2019-05-06_.json

Fichier PDF :

Si l'option est cochée, les fichiers PDF des factures présentes dans l'export sont situé sdans le fichier zip dans les sous-dossiers : pdf/{type_d'activité}/{code_dossier}/{nom_document}.pdf

ex: conciliator-json_export-2019-05-06-14-15-42/pdf/AGRI/5721/00052eda-e51c-4e93-bce4-467640092bd4.pdf