Admin-IS / Admin-Consult API activatie en configuratie

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. Dit moet ook gebeuren voor de Algemene Verordening Gegevensbescherming (GDPR).

De oude manier van werken met een rechtstreekse databaseconnectie wordt vanaf 01/01/2021 niet meer opgezet en vanaf 30/06/2021 definitief afgesloten. Deze timing geeft iedereen de tijd om de nodige migraties te doen. 

De Consult API kan on premise gebruikt worden zoals alle andere Marketplace integraties en ook extern via het Internet zoals Admin-Mobile, deze opzet vereist wel extra netwerkconfiguratie door de IT-afdeling. Mogelijke oplossing zijn Firewall configuratie of port forwaring met IIS.

Inhoudstafel

Installatie marketplace

Plugin Instellen

Configuratie

Connectiegegevens

On premise gebruik

Internet gebruik

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 plugin actief te hebben.
Daarna kan je via de knop "installeren" de plugin activeren. Na 30 tot 60 seconden zal de plugin actief staan.

Plugin Instellen

Configuratie

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

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

(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.

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.189:2100/api/v1/

Internet gebruik

Stem af met de IT-afdeling voor het juiste publieke adres/website.

Het uiteindelijke adres: publieke IP adres + de sleutel moeten doorgegeven worden aan de softwareleverancier.

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.

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.

Versies

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

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

27-10-2020 - v1.1.4.5

• Vanaf Admin-IS / Admin-Consult v9.1.0.10
• Uitbreiding API: HRM: Employee.LoginName

16-10-2020 - v1.1.4.3

• Vanaf Admin-IS / Admin-Consult v9.1.0.10
• Uitbreiding API: DMS: FilePostedBy, FilePostedOn, FileInfo

24-9-2020 - v1.1.4.2

• Vanaf Admin-IS / Admin-Consult v9.1.0.10
• Uitbreiding API: ExtraField

24-9-2020 - v1.1.3.9

• Vanaf Admin-IS / Admin-Consult v9.1.0.10
• Uitbreiding API:
  
  1) Customer.CustomerCrmType 
      CustomerCrmType can be found through API GET /api/v1/customercrmtypes
  2) Customer.CustomerGroup
      CustomerGroup can be found through API GET /api/v1/customergroups
  3) CustomerJuridical.ClosingDate
      e.g. '2020-12-31'
  4) Customer.IsActive
  5) Customer.SocialSecurityNumber
  6) Customer.AccountancySoftware
      AccountancySoftware can be found through API GET /api/v1/accountancysoftwares
  7) customer_metadata
      BillToBox info
  
  

31-8-2020 - v1.1.3.7

• Vanaf Admin-IS / Admin-Consult v9.1.0.10
• Uitbreiding API
• Data filters
• Pagineren
• interne verbeteringen

8-7-2020 - v1.1.0.3

• Vanaf Admin-IS / Admin-Consult v9.1.010