A.P.I

Il est possible d'adapter BonneFacture à vos besoins ou de l'interfacer avec vos autres logiciels grâce à notre architecture en web service, et ceci sans avoir besoin de compétences particulières. Voici la documentation technique nécessaire.

Architecture

BonneFacture est composé de deux éléments logiciels : l'interface utilisateur qui est un site web en HTML5 et en javascript d'une part et le serveur en charge des traitements et du stockage des données d'autre part. Ces deux parties communiquent entre-elles à l'aide de web-services.

Architecture BonneFacture

Il vous est donc possible d'interfacer BonneFacture avec vos logiciels, ou de créer une interface personnalisée.

Le modèle de données

L'interface en web service que nous mettons à votre disposition vous permet de manipuler les données du serveur. Pour en tirer profit, il vous faut avoir une vue générale du modèle de données que vous allez manipuler, c'est pourquoi vous trouverez ci-dessous un modèle simplifié présentant les objets principaux et leurs liens.

Modèle de donnée BonneFacture

Les documents comme les factures, devis et les messages de relance ou les demandes d'assistance sont modélisés par l'objet Message et les utilisateurs connectés par l'objet User. Les utilisateurs peuvent prendre de multiples identités ou avoir des correspondants modélisés sous la forme d'objet Person appartenant à des établissements Address eux-même faisant partie d'Organisation comme des entreprises. Les Person utilisables par un utilisateurs sont reliées à lui par des objets Contact.

Toutes les actions des utilisateurs sur ces messages (création, modification, réception, ...) font l'objet d'un MessageAction et peuvent être réalisés au nom d'une identité Person. Ces actions peuvent être, entre-autres, être des paiements Payment ou des envois Sending.

Les messages (factures, devis) ont sur leur entêtes un destinataire et un expéditeur. Ceci est spécifié par des rôles entre les Person et les Messages

Quand les messages sont des documents commerciaux comme les devis et les factures, ils ont aussi des lignes CommandLine avec des quantités qui les relient à des articles Item.

Les web services

Voici la liste des web services REST basés sur protocole HTTP et le format d'échange JSON. Ces protocoles présentent l'avantage d'être très simples et d'être à la base du web. Cette liste non exhaustive de ces services est relative à l'URL de base de l'application web http(s)://www.bonnefacture.eu/netscribe/.

/api/v1/activity-report
Statistiques, utilisant le standart Google Visualization
/api/v1/ad
Gestion des annonces générales.
/api/v1/currency
Gestion des monnaies
/api/v1/identity
Gestion des identités
/api/v1/image
Récupération et modification des logos.
/api/v1/messageAction
Permet d'annuler des actions.
/api/v1/messageList
Listes de messages/documents (mes documents, messages documents).
/api/v1/messageNumber
Séquences de numérotation de message.
/api/v1/message

Edition et récupération des messages et documents (factures, devis).

GET /api/v1/message/123 récupération du message 123
POST /api/v1/message création d'un message
POST /api/v1/message/123 modification du message 123
POST /api/v1/message/123/issue envoi du message 123
POST /api/v1/message/123/accept acceptation du message 123
POST /api/v1/message/123/refuse refus du message 123
POST /api/v1/message/123/addPayment ajout d'un paiement au message 123
POST /api/v1/message/123/delete supression du message 123
POST /api/v1/message/123/trash mise à la corbeille du message 123
POST /api/v1/message/123/restore sortie de la corbeille du message 123
/api/v1/oauth
Connection OAuth utilisant les comptes Google.
/api/v1/pdfExport
Export des messages en lots sous forme d'archives.
/api/v1/preference
Gestions des préférences et options.
/api/v1/session
Connection, inscription, oubli de mot de passe.
/api/v1/useCode
Changement de mot de passe et validation.
/api/v1/userFeedback
Demande d'assistance.
/api/v1/validation
Validation d'adresses email.
/pdf-docm/
Récupération des fichiers PDF.

Support sur l'API

Ce présent document donne une première vue générale de l'API. Nous détaillerons les différents services prochainement. En attendant, il est possible d'en savoir plus en utilisant les outils de développement présent dans vos navigateurs Google Chrome, Internet Explorer ou Firefox. Un onglet réseau permet en effet de voir les appels aux web services. Il vous suffit donc d'interagir avec le site web suivant le scénario qui vous intéresse et de regarder les appels réseau pour obtenir le détail des paramètres à envoyer et du format du résultat obtenu.

Si cela ne suffit pas, vous pouvez poser vos questions sur des forums dédiés au développement en français ou en anglais et nous envoyer un lien. Nous y répondrons et la réponse pourra servir à d'autres développeurs.

BonneFacture faisant l'objet d'un processus d'intégration continue, le modèle et les services sont susceptibles de changer par rapport à ce document.

Retour à la page principale.