Français (Belgique) English (US) Nederlands

Articles dans cette section

Afficher plus

Admin-IS / Admin-Consult API activation et configuration

Avatar
Roel Dhaens
Mise à jour
S’abonner

Introduction

Afin de donner aux comptables plus de contrôle sur l'utilisation de leurs données (base de données), d'autres parties telles que Silverfin et Codabox doivent demander l'accès aux comptables. 

L'ancienne façon de travailler avec une connexion directe à la base de données ne sera plus mise en place à partir du 01/01/2021 et sera fermée à partir du 31/12/2021. Ce timing donne à chacun le temps d'effectuer les migrations nécessaires.  Il y aura une communication intermédiaire avec les comptables et les intégrateurs de logiciels pour assurer le suivi du timing. 

Pour un accès en lecture seule, le comptable a une autre option: voir l'article Accès en lecture à la base de données Admin-IS / Admin-Consult en connexion avec Consult API.

L'API Consult est utilisée sur site comme toutes les autres intégrations de Marketplace. Dans des cas exceptionnels, il peut également être mis à disposition de l'extérieur via Internet ; toutefois, cette configuration nécessite une configuration supplémentaire du réseau par le département informatique.
Syneton ne peut pas vous supporter dans se sujet.

Les solutions possibles sont la configuration du pare-feu et le transfert de port avec IIS. L'article mentionne également quand vous pourriez utiliser cette

Table des matières

Installation Marketplace

Configuration Intégration

Configuration

Données de connexion

Utilisation sur on premise

Utilisation d'Internet

  Paramètres

Présentation de l'API

Usage du API

Environnement de test API

Versions

Installation Marketplace

Via Configuration - General - Marketplace vous trouvez la platforme.

D'abord il faut installer le Marketplace pour activer l'intégration.

Installer l'intégration se passe par cliquer le bouton installer. Après quelques secondes l'intégration sera active.

 

Configuration Intégration

Configuration

Via la configuration, vous pouvez déterminer quel logiciel a accès à quels modules. Le panneau de contrôle:

mceclip0.png

Cliquez sur le signe «+» et entrez le nom du logiciel auquel vous souhaitez accorder l'accès.

instellingen1-fr.png

(1) Une fois le logiciel créé, une clé unique est générée dont le vendeur du logiciel a besoin pour récupérer les données.

(2) Les signes "+" vous permettent d'accéder aux modules :

  1. Dossier permanent
  2. Financier
  3. Flux de travail
  4. DMS
  5. Enregistrements
  6. HRM

La colonne de gauche concerne les droits de lecture et la colonne de droite les droits d'écriture.

 

instellingen2-fr.png

Données de connexion

L'adresse (URL) pour utiliser la clé dépend de la configuration.

Utilisation sur on premise

Pour la configuration standard sur on premise, vous trouverez l'adresse dans la configuration du gestionnaire de Marketplace. L'adresse de l'éditeur du logiciel est l'adresse de base du Manager + le port de l'API Consult + "/api/v1/".

Dans ce cas: http://192.168.0.225:2100/api/v1/

mceclip4.png

Utilisation d'Internet

Toute connexion publique effectuée doit se faire via HTTPS, avec ou sans restriction basée sur l'adresse IP du développeur externe. L'accès à l'internet est destiné aux développeurs externes, pas aux fournisseurs externes, qui doivent travailler avec une application sur site qui utilise l'API et transmet les données à leur backend.

Coordonnez avec le responsable informatique pour l'adresse publique/site web correct. Il fera les ajustements nécessaires sur place. Cela n'entre pas dans le cadre des tâches et de l'assistance de Syneton. Les solutions possibles sont la configuration du pare-feu et le transfert de port avec IIS. L'adresse finale et le port de l'adresse IP publique sont déterminés par le responsable informatique.

 

La clé doit être transmise au fournisseur du logiciel pour qu'il puisse utiliser l'API.

Par exemple : https://consultapi.syneton.be:2100/api/v1/token/abcd1234-01234-5687-abcd-efghijklmnp

 

 

Paramètres

Dans "paramètres", vous pouvez modifier les paramètres par défaut de l'API.

 

instellingen3-fr.png

 

  • Nombre standard de résultats par appel API, si la demande est plus grand que le maximum .
  • Nombre maximum de résultats par page : Si vous demandez plus que le nombre maximum de résultats, seul le nombre de résultats par défaut sera affiché. Applicable aux Calls sur lesquels "paging" s'applique
  • Durée de vie du jeton (en heures)
  • Nombre maximal d'appels d'API par minute : un nombre plus élevé d'appels par minute entraînera l'affichage du message d'erreur "You are throttling the system". Vous devez attendre une minute avant de pouvoir effectuer d'autres appels à l'API.

standaard-instellingen-fr.png

 

Présentation de l'API

Via le lien de documentation, vous obtiendrez plus d'informations sur toutes les API possibles des modules.

Il s'agit d'une interface Swagger qui documente les possibilités et peut également être utilisée pour les tests.

Via le lien "API Config", vous revenez à l'écran de configuration de Consult API.

mceclip5.png

mceclip5.png

Usage du API

Un développeur peut maintenant commencer à travailler avec l'API.

Plus d'informations dans cet article :Admin-IS / Admin-Consult API pour le vendeur de logiciels

Environnement de test API

Il existe une API Consult en ligne que vous pouvez afficher et tester pour:

http://consultapi.syneton.be:2100/doc 

  • en ligne entre 7h et 19h
  • les données sont réinitialisées tous les dimanches soir à 22h

Demandez l'accès aux modules avec un ticket sur notre helpdesk en ligne Syneton.Zendesk.com.

Après cela, vous recevrez une clé pour utiliser l'API.

Signalez également les commentaires, questions ou problèmes avec un ticket.

Attention:

  • il s'agit d'un environnement partagé où tout le monde peut tester, veuillez faire attention aux données personnelles.
  • C'est également là que les nouveaux produits seront en test bêta, ils ne sont pas encore visibles en production. Ils seront publiés après approbation, mais peuvent également être retirés.

Versions

Comment obtenir une nouvelle version? Voir l'article Marketplace Général.

15-01-2024 - 1.2.0.6

  • Extensions API 
    • C'est possible de donner la raison et date de départ dans /api/v1/customers/{customerid}/deactivate (34579)
    • ajouter PUT pour CustomerAuthorisation (32142)
    • Endpoints pour gérer Project_Customer.(32478)
  • Améliorations internes 
    • Erreur chez Todo's est résolu (34599)
    • Desactivaton relation peut desactiver les projects (35139)
    • Interne verbeteringen (35009, 35316, 35009)

12-09-2023 - 1.2.0.2

  • Extensions API 
    • Ajouté DepartmentID au endpoint GET /api/v1/projects (33997)
    • Ajouté SUBTASK_ORDER au GET /api/v1/taskflow/tasks/{task_id}/subtasks (33513)
    • Ajouté "planningStop" sur PUT request chez /api/v1/projects/{projectid}/projectrecurringproducts & /api/v1/projects/{projectid}/projectrecurringexpenses (33483)
  • Améliorations internes (33587)

20-06-2023 - 1.1.5.99

  • Adaptation Swagger (33287)
  • extensionsAPI 
    • ajouter /api/v1/taskflow/tasks/{projectid}/plannedtasks (32983)
    • ajouter endpoint DELETE /api/v1/extrarecord (33235)
  • Améliorations internes (33278, 32981)

13-04-2023 - 1.1.5.97

  • extensions API
    • Ajouté couts recurrents materiel et non-materiel  (32337)
    • GET /api/v1/projects" a 2 champs supplementaires 'CompanyId' & 'InvoicePercentage' (32398)

06-04-2023 - 1.1.5.96

  • Améliorations internes
  • extensions API
    • API CustomerLinkCustomer montre la bonne date (31540)
    • Project/Changes endpoint  montre le nom du table (32338)

29-03-2023 - v1.1.5.95

  • Améliorations internes
  • extensions API
    • /api/v1/customers contient le champ Currency
    • /api/v1/employees contient l'ID du MainCompany

27-03-2023 - v1.1.5.92

  • extension du API

    • DELETE​/api​/v1​/customers​/{customerid}​/customeremployee​/{customeremployeepk} Toegevoegd

  • améliorations internes

19-12-2022 - v1.1.5.89

  • A partir de Admin-IS / Admin-Consult v9.1.0.10 - logiciel minimum .NET Framework 4.7.2 ou supérieur
  • API d'extension :
    • GET /api/v1/lists/{listid}: LegalForm a été ajouté
    • POST /api/v1/projects/{projectid}/projectcontacts
    • PUT /api/v1/customers : Distance a été ajouté
  • Améliorations internes

24-11-2022 - v1.1.5.85

  • A partir de Admin-IS / Admin-Consult v9.1.0.10 - logiciel minimum .NET Framework 4.7.2 ou supérieur
  • API d'extension :
    • GET /api/v1/timeregistrations/changes : filtre possible sur ActionType
    • PUT /api/v1/customers : Title peut être vide

15-11-2022 - v1.1.5.83

  • A partir de Admin-IS / Admin-Consult v9.1.0.10 - logiciel minimum .NET Framework 4.7.2 ou supérieur
  • API d'extension :
    • GET /api/v1/customer/changes: UserId a été ajouté
    • POST /api/v1/taskflow/tasks/{taskid}/update : UserName a été ajouté

24-10-2022 - v1.1.5.82

  • A partir de Admin-IS / Admin-Consult v9.1.0.10 - logiciel minimum .NET Framework 4.7.2 ou supérieur
  • API d'extension :
    • GET api/v1/customeraddresses
    • GET api/v1/lists/ : ExtCode ajouté à la liste des titres et des fonctions de contact 

29-09-2022 - v1.1.5.81

  • A partir de Admin-IS / Admin-Consult v9.1.0.10 - logiciel minimum .NET Framework 4.7.2 ou supérieur
  • API d'extension :
    • PUT /api/v1/customers : les champs qui ne sont pas fournis ne sont pas vidés
    • GET api/v1/customers/{customerid}/juridical : GeneralMeetingDescription est une représentation lisible.

02-09-2022 - v1.1.5.80

  • A partir de Admin-IS / Admin-Consult v9.1.0.10 - logiciel minimum .NET Framework 4.7.2 ou supérieur
  • API d'extension :
    • GET/PUT/POST  /api/v1/customers/{customerid}/emaildata
    • GET /api/v1/customers/: CustomerGroupLabel et AccountancySoftwareLabel a été ajouté

30-08-2022 - v1.1.5.79

  • A partir de Admin-IS / Admin-Consult v9.1.0.10 - logiciel minimum .NET Framework 4.7.2 ou supérieur
  • Améliorations internes

22-08-2022 - v1.1.5.78

  • A partir de Admin-IS / Admin-Consult v9.1.0.10 - logiciel minimum .NET Framework 4.7.2 ou supérieur
  • API d'extension :
    • DELETE ​/api​/v1​/timeregistrations
    • GET /api/v1/customer/changes et api/v1/changedetails: CUSTOMER_FUNCTION_USER a été ajouté
    • PUT /api/v1/expensedeclarations/{expensedeclarationid}/clearinvoice
    • GET /api/v1/lists: Commsercial Courts a été ajouté comme liste
    • GET /api/v1/customers: DisabledDate et ReasonForLeaving a été ajouté
    • DELETE /api/v1/taskflow/tasks/[projectid]/plannedtasks/[taskplanningid]
    • GET /api/v1/taskflow/taskschedules
    • GET/PUT /api/v1/taskflow/tasks/[projectid]/plannedtasks

30-06-2022 - v1.1.5.73

  • A partir de Admin-IS / Admin-Consult v9.1.0.10 - logiciel minimum .NET Framework 4.7.2 ou supérieur
  • La documentation Swagger est conforme à la norme 2.0
  • API d'extension :
    • GET /api/v1/taskflow/tasks/{taskid}/subtasks : ajout de SubTaskPercentage et SubTaskResponsable
    • GET /api/v1/nacecodes
    • PUT / GET /api/v1/customers : NaceCode a été ajouté
    • PUT/POST/GET /api/v1/customers : Remarks peut contenir plus de 250 caractères.
    • Les adresses sont divisées en HouseBox, HouseNr, Streetname. Street1 sera conservée.
  • Améliorations internes

 

15-06-2022 - v1.1.5.72

  • A partir de Admin-IS / Admin-Consult v9.1.0.10 - logiciel minimum .NET Framework 4.7.2 ou supérieur 
  • API d'extension :
    • GET /api/v1/customers/{customer_id}/addresses : CustomerAddressId a été ajouté
    • GET /api/v1/timeregistrations : customerInvoiceId a été ajouté
    • PUT /api/v1/customers : RPR et CupboardNumber ont été ajoutés
    • PUT /api/v1/timeregistrations/{timeregistrationid}/setinvoiced : définir les enregistrements de temps comme facturés
    • PUT /api/v1/expensedeclarations/{expensedeclarationid}/setinvoiced : définir les coûts non matériels comme facturés
    • PUT /api/v1/productuses/{productuseid}/setinvoiced : définir les coûts des matériaux comme facturés
    • GET /api/v1/customers/{customer_id}/addresses : CustomerAddressId a été ajouté
    • GET /api/v1/projectcontacts
  • Améliorations internes

13-04-2022 - v1.1.5.69

  • À partir de Admin-IS / Admin-Consult v9.1.0.10 - logiciel minimum .NET Framework 4.7.2 ou supérieur
  • API d'extension :
      • POST /api/v1/customers/{customerid}/private: Le fichier eID est converti en fichier pdf et jpg.
      • POST /api/v1/customers/{customerid}/customerlinkcustomer: Ajouter le même actionnaire avec un StockType différent

28-03-2022 - v1.1.5.67

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension :
      • GET /api/v1/employeeworkinghours
      • GET /api/v1/projects en /api/v1/ et  /api/v1/customers/{customerid}/projects : ProjectTypeId, ProjectManagerId et ProjectStatusId ont été ajoutés.
      • GET api/v1/customer :  Sector en SectorId ont été ajoutés.

14-03-2022 - v1.1.5.65

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension :
        • GET /api/v1/nacecodes

24-02-2022 - v1.1.5.64

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension :
      • /api/v1/customers/{customerid}/juridical : GeneralMeetingFormula et GenerelMeetingDescription en GET, GenerelMeetingFormula en POST
      • POST /api/v1/taskflow/tasks/{taskid}/data : la chaîne vide ("") est autorisée comme valeur
      • GET /api/v1/taskflow/tasks/{taskid}/data : la sous-tâche peut contenir une virgule inversée (")
      • GET /api/v1/token/{softwarekey}: TimeToLive toujours sans zone horaire

15-02-2022 - v1.1.5.63

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension :
      • POST /api/v1/dms/file/{fileid}/upload : télécharger le fichier .eid
      • POST /api/v1/customers/{customerid}/private : liaison du fichier .eid
      • PUT /api/v1/projects/1/invoicingdata : correction de la mise à jour d'un champ

10-02-2022 - v1.1.5.62

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • Les améliorations internes

08-02-2022 - v1.1.5.61

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension :
      • PUT  api/v1/projects/1/invoicingdata: mise à jour d'un seul champ autorisée

28-01-2022 - v1.1.5.59

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • Les améliorations internes

26-01-2022 - v1.1.5.58

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension :
      • Plusieurs 'Contains', 'StartsWith', 'EndsWith' sont autorisés.
      • GET /api/v1/customerlinkcustomer
      • GET /api/v1/invoicingplanning

17-01-2022 - v1.1.5.55

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension :
      • ​POST /api​/v1​/customers​/{customerid}​/social
      • GET /api/v1/countries
      • PUT /api/v1/customers/{customerid}/addresses/{addressid}
      • POST /api/v1/customers/{customerid}/addresses
      • DELETE /api/v1/customers/{customerid}/addresses/{addressid}

      • POST /api/v1/projects/{projectid}/invoicingdata

      • GET /api/v1/projects/{projectid}/invoicingdata

      • Paramètres supplémentaires pour la reprise de documents pour les employés et les entreprises

24-12-2021 - v1.1.5.52

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension :
      • ​POST /api/v1/customers/{customerid}/juridical : LeiNumber, LeiValidUntil

22-12-2021 - v1.1.5.51

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension :
      • ​GET/POST /api/v1/todos
      • PUT /api/v1/todos/{todoid}/update
      • PUT /api/v1/projects/{projectid} : ProjectManager

9-12-2021 - v1.1.5.49

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension :
      • ​/api/v1/customers: Fax, ComercialName, CupboardNumber
      • POST /api/v1/dms/file/{fileid}/overwrite
      • POST /api/v1/customers/{customerid}/private : PlaceOfBirth, DateOfBirth
      • POST /api/v1/customers/{customerid}/deactivate
      • POST /api/v1/projects/{projectid}/deactivate 

8-12-2021 - v1.1.5.48

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension :
      • ​POST /api/v1/customers/{customerid}/TAX
      • POST /api/v1/customers/{customerid}/VAT
      • POST /api/v1/customers/{customerid}/juridical
      • POST - PUT /api/v1/customers/ : SocialSecurityNumber
      • ​les améliorations internes

25-11-2021 - v1.1.5.45

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension :
      • ​/api/v1/employees: UserData
      • /api/v1/customers: Accountancysoftware
      • /api/v1/accountancysoftwares
      • ​DELETE /api/v1/customers/{customerid}/customerauthorization/{customerauthorizationid}

17-11-2021 - v1.1.5.42

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension :
      • ​PUT/GET /api/v1/customers/{customerid}/juridical
      • ​les améliorations internes

28-09-2021 - v1.1.5.37

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension :
      • ​model CustomerBank has extra property: AccountType
      • model Project has extra property: IsTaskflowCustomer
      • ​delete/api​/v1​/customers​/{customerid}​/customerlinkcustomer​/{customerlinkcustomerid}: delete a linked customer

13-09-2021 - v1.1.5.35

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension :
      • ​/api​/v1​/dms​/file​/{fileid}​/history:  DMS file history
      • ​/api​/v1​/employees​/{employeeid}​/contract: financial data

 

10-08-2021 - v1.1.5.32

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension :
      • /api/v1/timeregistrations:  InternalRemarks and Remarks fixed
      • PUT /api/v1/timeregistrations: TimeRegistrationId skipped and created by system
      • /api/v1/externaladdresses
      • /api/v1/projectauthorizedregistrations
      • /api/v1/projectauthorizedemployees

05-07-2021 - v1.1.5.28

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • Lorsque la licence Admin-IS / Admin-Consult a expiré, l'utilisation de l'API n'est plus possible et vous obtenez le message d'erreur "Licence invalide"
  • API d'extension: 
      • api/v1/projects/changes
      • /api/v1/customerbanks to find customers by IBAN (Filter=IBAN eq 'BE12123412341234' )
      • POST ​/api​/v1​/timeregistrations: fixed "Err" not found
      • /api/v1/customer/changes: also "E-mail destinataires" as Tablename = 'CUSTOMER_EMAIL'

30-06-2021 - v1.1.5.26

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension: 
      • Customer.RPR ("rechtspersonenregister")
      • ProductItem.OrderNr
      • /api/v1/dms/prefixes
      • ​/api​/v1​/taskflow​/tasks​/{taskid}​/data : DB error fix
      • better errorhandling: 
          • 400 Bad request e.g. all projects for a customer if there are no projects
          • 404 Not Found e.g. all projects of a customer that does not exist, invalid paging parameters like asking the next page after the last page

 

09-06-2021 - v1.1.5.23

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension: 
      • /api/v1/customer/changes: includes all data of model CustomerLinkCustomer
      • fix occasionally "SELECT returns more than one row" for API's returning language dependent data

03-06-2021 - v1.1.5.22

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension:  
      • PUT /api/v1/customers/{customerid}/banks update existing bank
      • ​customeremployees and projectemployees: isActive
      • /api/v1/projects: all projects unrelated to a customer, can be filtered
      • /api​/v1​/timeregistrations​/changes: can be filterd

10-05-2021 - v1.1.5.20

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension:  
      • ​/api​/v1​/customeremployees: all employees linked to a customer
      • /api/v1/projectemployees: all employees linked to a project
      • Project.ProjectStatus fixed
      • api/v1/customerlinktypes includes -1=External addresses
      • CustomerPrivat.EidFile fixed
      • api/v1/customers/{customerid}/projects: "Illegal reference to correlation name 'p'" fixed

31-03-2021 - v1.1.5.18

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension: 
      • External File: spaces in column names allowed
      • UBO: all data available
      • Configuration page: "Software" renamed to "API gebruikers"
      • Configuration page: Settings: 
          • default records per page
          • max records per page
          • TimeToLive of session token
          • max API calls per minute
      • /api/v1/apisettings 
      • /api/v1/customer/changes: also for customer_address 
      • Model Customer includes second phone number (Phone2)
      • Language parameter for an API account (utilisateur) for code translations. Current accounts default to Dutch.

19-01-2021 - v1.1.5.14

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension API:  External File (known issue: spaces in column names), Invoice Email Recepients, Country Code in Customer Adresses

 

19-01-2021 - v1.1.5.6

  • À partir de Admin-IS / Admin-Consult v9.1.0.10
  • API d'extension API: customer/changes et Changedetails

Articles associés

Commentaires

0 commentaire

Vous devez vous connecter pour laisser un commentaire.