API

L'API eFactori permet à un programme externe d'accéder aux fonctions d'eFactori de manière automatisée. Par exemple, un programme externe peut récupérer des listes de clients, créer de nouveaux clients ou créer des documents de manière sécurisée.

Une "API" est une interface technique qui peut être utilisée par une application tierce. Pour appeler l'API, des connaissances techniques sont nécessaires et vous devrez programmer de nouvelles fonctions à partir du programme externe pour appeler l'API.

L'API suit l'architecture REST classique. Les informations détaillées de chaque fonction API peuvent être trouvées via le lien swagger suivant : API Reference

onfact | Stoplight

Authentification

Authentification API-Key

Le moyen le plus simple d'authentifier le lien est d'utiliser une clé API. Cette méthode est destinée aux liens développés spécifiquement pour une entreprise, par cette entreprise. Si vous développez un lien multi-utilisateurs avec eFactori, vous devez utiliser l'authentification 'oAuth 2.0'.

Pour l'authentification par clé API, vous devez ajouter deux en-têtes à chaque demande : l'en-tête X-SESSION-KEY et l'en-tête X-COMPANY-UUID. Vous pouvez les trouver dans eFactori via le menu supérieur droit "Paramètres personnels".

Récupérer des factures

GET https://api5.onfact.be/v1/invoices.json

Obtenez une liste de factures

Headers

Name	Type	Description
X-COMPANY-UUID	String	UUID de l'entreprise
X-SESSION-KEY	String	API Key

200: OK

{
    // Response
}

Extensions URL

L'API REST décrit les 'resource endpoints' sans extension, celle-ci doit être ajoutée à l'URL. L'extension détermine le format dans lequel les ressources sont affichées. Dans presque tous les cas, vous devrez ajouter l'extension .json à l'URL. Pour les documents, vous pouvez également utiliser l'extension .pdf, .html ou .xml.

Pour récupérer une facture au format json, vous devrez utiliser la requête suivante :

Récupérer les détails de la facture

GET https://api5.onfact.be/v1/invoices/:id.json

Obtenez les informations d'une facture

Path Parameters

Name	Type	Description
	String	ID de facture

Headers

Name	Type	Description
X-SESSION-KEY	String	API Key
X-COMPANY-UUID	String	UUID de l'entreprise

200: OK

{
    // Response
}

Fonctions spéciales

Pour simplifier l'utilisation de l'API, certaines fonctions spéciales sont intégrées lors de la création de documents. Lors de la création d'un document, vous pouvez immédiatement ajouter une action afin qu'eFactori lie le document créé à un enregistrement client ou crée un nouvel enregistrement client s'il n'en existe pas. Pour ce faire, vous ajoutez le header X-ACTIONS avec la valeur FIND-OR-CREATE-CUSTOMER.

Les valeurs possibles sont :

• CREATE-CUSTOMER

• FIND-OR-CREATE-CUSTOMER

• UPDATE-CUSTOMER

• FIND-PRODUCTS

• USE-FIRST-DESCRIPTION

• USE-FIRST-TOPTEXT-DESCRIPTION

Plusieurs actions peuvent être combinées en les séparant par une virgule.

Créer une facture

POST https://api5.onfact.be/v1/invoices/:id.json

Path Parameters

Name	Type	Description
	String	ID Facture

Headers

Name	Type	Description
X-ACTIONS	String	FIND-OR-CREATE-CUSTOMER
X-SESSION-KEY	String	API Key
X-COMPANY-UUID	String	UUID de l'entreprise

200: OK

{
    // Response
}