Nederlands English (US) Français (Belgique)

Artikelen in deze sectie

Zie meer

Admin-IS / Admin-Consult API activatie en configuratie

Avatar
Johan Awouters
Bijgewerkt
Volgen

Inleiding

Om de accountants meer controle te geven over het gebruik van hun data (database) moeten andere softwareleveranciers toegang vragen tot de database van de accountants. 

De oude manier van werken met een rechtstreekse databaseconnectie wordt vanaf 01/01/2021 niet meer opgezet en vanaf 31/12/2021 definitief afgesloten. Deze timing geeft iedereen de tijd om de nodige migraties te doen. Er volgt nog tussentijdse communicatie met de accountants en software integratoren om de timing op te volgen. 

Voor uitsluitend leesrechten heeft de accountant nog een optie, zie het artikel Leesrechten op de database van Admin-IS / Admin-Consult i.v.m. Consult API.

De Consult API wordt on premise gebruikt zoals alle andere Marketplace integraties. In uitzonderlijke gevallen kan deze ook extern via het Internet beschikbaar gesteld worden, deze opzet vereist wel extra netwerkconfiguratie door de IT-afdeling. Syneton kan u hier geen ondersteuning in geven. 
Mogelijke oplossing zijn Firewall configuratie en port forwarding met IIS. In dat artikel staat ook aangegeven wanneer u dat zou kunnen gebruiken.

Inhoudstafel

Installatie marketplace

Integratie Instellen

Configuratie

Connectiegegevens

On premise gebruik

Internet gebruik

   Instellingen

API overzicht

API testomgeving

Versies

Installatie marketplace

Via [Configuratie - algemeen - Marketplace] vind je het Marketplace platform.
Je dient eerst de Marketplace te installeren om deze integratie actief te hebben.
Daarna kan je via de knop "installeren" de integratie activeren. Na enkele seconden zal de integratie actief staan.

 

Integratie Instellen

Configuratie

Via de configuratie kan je bepalen welke software toegang heeft op welke modules.

mceclip2.png

Klik op het "+"-teken en geef de naam op van de software die je toegang wilt verlenen: instellingen1.png

(1) Eenmaal de software is aangemaakt, wordt er een unieke sleutel gegenereerd die de softwareleverancier nodig heeft om data op te vragen. 

(2) met de "+"-tekens kan je toegang geven tot de modules:

  1. Permanent Dossier
  2. Financial
  3. Taskflow
  4. DMS
  5. Registraties
  6. HRM

De linker kolom is voor de leesrechten en de rechter kolom is voor de schrijfrechten.

instellingen2.png

 

Connectiegegevens

Het adres(URL) om de sleutel te gebruiken hangt af van de configuratie. 

On premise gebruik

Voor de standaard on premise configuratie vind je het adres terug in de configuratie van de Marketplace Mananger. Het adres voor de softwareleverancier is het basisadres van de Manager + de poort van de Consult API + "/api/v1/".

Met onderstaand voorbeeld geeft dit: http://192.168.0.225:2100/api/v1/

mceclip5.png

 

Internet gebruik

Elke publieke connectie die gelegd wordt moet via HTTPS verlopen, al dan niet met restrictie op basis van het IP-adres van de externe developer. De internettoegang is bedoeld voor externe developers, niet voor externe leveranciers, deze moeten werken met een on premise app die de API gebruikt en de data doorgeeft aan hun backend.

Stem af met de IT-verantwoordelijke voor het juiste publieke adres/website, hij zal de nodige aanpassing on premise doen. Dit valt buiten het takenpakket en support van Syneton.
Mogelijke oplossing zijn Firewall configuratie en port forwarding met IIS. Het uiteindelijke adres en poort van het publieke IP adres wordt bepaald door de IT-verantwoordelijke. 

 

De sleutel moeten doorgegeven worden aan de softwareleverancier zodat ze de API kunnen gebruiken.

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

 

 

Instellingen

Bij 'instellingen' kan je de standaard API instellingen wijzigen.

 

instellingen3.png

 

  • Standaard aantal resultaten per API call
  • Maximum aantal resultaten per pagina: Indien je er meer opvraagt dan het maximum aantal dan zullen enkel het standaard aantal resultaten getoond worden.
  • Levensduur van het token (in uren)
  • Maximum aantal API oproepen per minuut: meer oproepen per minuut zal de foutmelding "You are throttling the system" weergeven. Er moet één minuut gewacht worden alvorens er weer API calls kunnen gebeuren.

standaard-instellingen.png

 

API overzicht

Via de documentatie link krijg je meer informatie over alle mogelijke API’s van de modules. 

Dit is een Swagger interface die de mogelijkheden documenteert en ook kan gebruikt worden om te testen .

Via de API Config link ga je terug naar het configuratiescherm van Consult API.

mceclip6.png

mceclip5.png

 

Gebruik van de API

Een developer kan nu aan de slag met de API.

Meer info in dit artikel: Admin-IS / Admin-Consult API Werking voor de Softwareleverancier

API testomgeving

Er staat een Consult API online die je kan bekijken en testen op:

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

  • online tussen 7u en 19u
  • de gegevens worden gereset elke zondagavond om 22u

Toegang aanvragen voor modules met een ticket op onze online helpdesk Syneton.Zendesk.com.

Hierna krijg je een sleutel om de API te gebruiken.

Opmerkingen, vragen of problemen eveneens melden met een ticket.

Opgelet:

  • Dit is één gedeelde omgeving waar iedereen kan testen, gelieve op te letten met persoonlijke data.
  • Hier komen ook de nieuwe items in bèta-test, deze zijn nog niet zichtbaar in productie.
    Deze worden na goedkeuring gereleased, maar kunnen ook weer worden ingetrokken

 

Versies

Hoe een nieuwe versie krijgen? Zie artikel Marketplace Algemeen, Nieuwe Versies.

24-11-2022 - v1.1.5.85

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10 - minimum software .NET Framework 4.7.2 of hoger
  • Uitbreiding API:
    • GET /api/v1/timeregistrations/changes : filter mogelijk op ActionType
    • PUT /api/v1/customers : Title mag leeg zijn

15-11-2022 - v1.1.5.83

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10 - minimum software .NET Framework 4.7.2 of hoger
  • Uitbreiding API:
    • GET /api/v1/customer/changes: UserId werd toegevoegd
    • POST /api/v1/taskflow/tasks/{taskid}/update : UserName werd toegevoegd

24-10-2022 - v1.1.5.82

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10 - minimum software .NET Framework 4.7.2 of hoger
  • Uitbreiding API:
    • GET api/v1/customeraddresses
    • GET api/v1/lists/ : ExtCode toegevoegd aan lijst van titels en contactfuncties 

29-09-2022 - v1.1.5.81

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10 - minimum software .NET Framework 4.7.2 of hoger
  • Uitbreiding API:
    • PUT /api/v1/customers: velden die niet worden meegegeven worden niet leeg gemaakt
    • GET api​/v1​/customers​/{customerid}​/juridical: GeneralMeetingDescription is een leesbare weergave

02-09-2022 - v1.1.5.80

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10 - minimum software .NET Framework 4.7.2 of hoger
  • Uitbreiding API:
    • GET/PUT/POST  /api/v1/customers/{customerid}/emaildata
    • GET /api/v1/customers/: CustomerGroupLabel en AccountancySoftwareLabel werden toegevoegd

30-08-2022 - v1.1.5.79

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10 - minimum software .NET Framework 4.7.2 of hoger
  • Interne verbeteringen

22-08-2022 - v1.1.5.78

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10 - minimum software .NET Framework 4.7.2 of hoger
  • Uitbreiding API:
    • DELETE ​/api​/v1​/timeregistrations
    • GET /api/v1/customer/changes en api/v1/changedetails: CUSTOMER_FUNCTION_USER werd toegevoegd
    • PUT /api/v1/expensedeclarations/{expensedeclarationid}/clearinvoice
    • GET /api/v1/lists: Commsercial Courts werd als lijst toegevoegd
    • GET /api/v1/customers: DisabledDate en ReasonForLeaving werd toegevoegd
    • 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

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10 - minimum software .NET Framework 4.7.2 of hoger 
  • Swagger documentatie is 2.0 compliant
  • Uitbreiding API:
    • GET ​/api​/v1​/taskflow​/tasks​/{taskid}​/subtasks : SubTaskPercentage en SubTaskResponsable werden toegevoegd
    • GET /api/v1/nacecodes
    • PUT / GET ​/api​/v1​/customers: NaceCode werd toegevoegd
    • PUT/POST/GET /api/v1/customers: Remarks veld kan meer dan 250 karakters bevatten
    • Adressen worden opgesplitst in HouseBox, HouseNr, Streetname. Street1 blijft behouden.
  • Interne verbeteringen

15-06-2022 - v1.1.5.72

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10 - minimum software .NET Framework 4.7.2 of hoger 
  • Uitbreiding API:
    • GET /api/v1/customers/{customer_id}/addresses: CustomerAddressId werd toegevoegd
    • GET /api/v1/timeregistrations: customerInvoiceId werd toegevoegd
    • PUT /api/v1/customers: RPR en CupboardNumber werd toegevoegd
    • PUT /api/v1/timeregistrations/{timeregistrationid}/setinvoiced: zet tijdsregistratie als gefactureerd
    • PUT /api/v1/expensedeclarations/{expensedeclarationid}/setinvoiced: zet niet-materiële kosten als gefactureerd
    • PUT /api/v1/productuses/{productuseid}/setinvoiced: zet materiële kosten als gefactureerd
    • GET /api/v1/customers/{customer_id}/addresses: CustomerAddressId werd toegevoegd
    • GET /api/v1/projectcontacts
  • Interne verbeteringen

13-04-2022 - v1.1.5.69

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10 - minimum software .NET Framework 4.7.2 of hoger 
  • Uitbreiding API:
      • POST /api/v1/customers/{customerid}/private: eID bestand wordt geconverteerd naar pdf- en jpg-bestand
      • POST /api/v1/customers/{customerid}/customerlinkcustomer: zelfde aandeelhouder toevoegen met ander StockType

28-03-2022 - v1.1.5.67

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API:
      • GET /api/v1/employeeworkinghours
      • GET /api/v1/projects en /api/v1/ en  /api/v1/customers/{customerid}/projects: ProjectTypeId, ProjectStatusId en ProjectManagerId werd toegevoegd
      • GET api/v1/customer:  Sector en SectorId werden toegevoegd

14-03-2022 - v1.1.5.65

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API:
      • GET /api/v1/nacecodes

24-02-2022 - v1.1.5.64

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API:
      • /api/v1/customers/{customerid}/juridical: GeneralMeetingFormula en GenerelMeetingDescription in GET, GenerelMeetingFormula in POST 
      • POST /api/v1/taskflow/tasks/{taskid}/data:  lege string waarde ("") wordt toegelaten als value
      • GET /api/v1/taskflow/tasks/{taskid}/data: subtaak mag aanhalingsteken (") bevatten
      • GET /api/v1/token/{softwarekey}: TimeToLive steeds zonder timezone

15-02-2022 - v1.1.5.63

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API:
      • POST /api/v1/dms/file/{fileid}/upload: uploaden van .eid-file
      • POST /api/v1/customers/{customerid}/private: koppelen van .eid-file
      • PUT /api/v1/projects/1/invoicingdata: verbetering van update van één veld

10-02-2022 - v1.1.5.62

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Interne verbeteringen

08-02-2022 - v1.1.5.61

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API:
      • PUT api/v1/projects/1/invoicingdata : update van één veld toegelaten

28-01-2022 - v1.1.5.59

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Interne verbeteringen

26-01-2022 - v1.1.5.58

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API:
      • Meerdere 'Contains', 'StartsWith', 'EndsWith' worden toegelaten
      • GET /api/v1/customerlinkcustomer
      • GET /api/v1/invoicingplanning

17-01-2022 - v1.1.5.55

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API:
      • ​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

      • Extra settings voor ophalen van documenten voor medewerkers en bedrijven

24-12-2021 - v1.1.5.52

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API:
      • ​POST /api/v1/customers/{customerid}/juridical : LeiNumber, LeiValidUntil

22-12-2021 - v1.1.5.51

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API:
      • ​GET/POST /api/v1/todos
      • PUT /api/v1/todos/{todoid}/update
      • PUT /api/v1/projects/{projectid} : ProjectManager

9-12-2021 - v1.1.5.49

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API:
      • ​/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

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API:
      • ​POST /api/v1/customers/{customerid}/TAX
      • POST /api/v1/customers/{customerid}/VAT
      • POST /api/v1/customers/{customerid}/juridical
      • POST - PUT /api/v1/customers/ : SocialSecurityNumber
      • interne verbeteringen

25-11-2021 - v1.1.5.45

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API:
      • ​/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

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API:
      • ​PUT/GET /api/v1/customers/{customerid}/juridical
      • ​interne verbeteringen

28-09-2021 - v1.1.5.37

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API:
      • ​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

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API:
      • ​/api​/v1​/dms​/file​/{fileid}​/history:  DMS file history
      • ​/api​/v1​/employees​/{employeeid}​/contract: financial data

10-08-2021 - v1.1.5.32

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API:
      • /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

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Wanneer de Admin-IS / Admin-Consult licentie vervallen is, is er geen API-gebruik meer mogelijk en krijg je de foutmelding 'Ongeldige licentie"
  • Uitbreiding API: 
      • 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-mailbestemmelingen" as Tablename = 'CUSTOMER_EMAIL'

30-06-2021 - v1.1.5.26

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API: 
      • Customer.RPR ("rechtspersonenregister")
      • ProductItem.OrderNr
      • /api/v1/dms/prefixes
      • ​/api​/v1​/taskflow​/tasks​/{taskid}​/data : DB error fix
      • bettere 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

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API: 
      • /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

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API: 
      • 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

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API: 
      • ​/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

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API: 
      • 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 (gebruiker) for code translations. Current accounts default to Dutch.

26-02-2021 - v1.1.5.14

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API:  External File (known issue: spaces in column names), Invoice Email Recepients, Country Code in Customer Adresses

19-01-2021 - v1.1.5.6

  • Vanaf Admin-IS / Admin-Consult v9.1.0.10
  • Uitbreiding API: customer/changes and Changedetails

Verwante artikelen

Opmerkingen

0 opmerkingen

U moet u aanmelden om een opmerking te plaatsen.