Inleiding tot de MKG API

Hoe werkt de MKG API?

De MKG API laat MKG en een ander softwareprogramma via het internet met elkaar communiceren. Dit gaat via de webserver. Het RESTmodel is het standaardmodel voor het vormgeven van de berichten die worden uitgewisseld volgens de HTTP-standaard. Het initiatief voor de communicatie ligt bij het andere softwareprogramma. De MKG API zorgt slechts voor het doorgeven van de gegevens en uitvoeren van acties tussen MKG en het andere softwareprogramma. Een voorbeeld: het gereedmelden van een specifieke productieorder kun je als 'opdracht' meegeven via de API. De API luistert hiernaar en voert dit op de achtergrond uit binnen MKG.

In principe moet alles één keer geprogrammeerd worden, waarna de data steeds kan worden uitgewisseld. Via mapping moet een vertaalslag worden gemaakt tussen het te koppelen programma en MKG, omdat niet alles op dezelfde manier is ingevoerd en de velden niet compleet overeen zullen komen met de velden van MKG. Hierbij wordt bijvoorbeeld ingesteld dat de gegevens van veld A van het programma naar veld B in MKG gezet moeten worden in een specifiek formaat.

Voorbeelden van opvragen data:

Het antwoord wordt in een gestandaardiseerd gegevensformaat teruggegeven, het JSON-formaat.

Waar kan de API voor gebruikt worden?

In algemene zin heeft de achterliggende (API-)techniek eindeloze mogelijkheden. Voor de MKG API is de basis echter dat deze kan fungeren als een externe MKG gebruiker. Wij streven ernaar dat de API over dezelfde functionaliteiten beschikt als een Office gebruiker in MKG.

Enkele voorbeelden voor het gebruik van de MKG API in het bedrijfsleven:

• Een webshop koppelen aan MKG. Vanuit de webshop kunnen bijvoorbeeld gegevens van verkooporders via de API naar MKG gezet worden.
• Machines koppelen aan MKG. Op de werkvloer staan machines die uren en/of aantallen door kunnen geven aan MKG. Tevens kunnen zij planningsgegevens opvragen uit MKG.
• Tekenprogramma’s, zoals CAD-software koppelen aan MKG. Het tekenprogramma kan via de API materialen/artikelen ophalen uit MKG om te koppelen aan een tekening, waarna het weer teruggezet kan worden naar MKG met een tekening- of revisienummer.
• Je eigen telefooncentrale koppelen aan MKG, zodat relatie- en contactgegevens worden gesynchroniseerd.

Aanvullende informatie voor ontwikkelaars

• De functies (services) en tabellen worden gefaseerd vrijgegeven.
• Het heeft de voorkeur om functieaanroepen te gebruiken voor procesgestuurde acties, bijvoorbeeld het gereedmelden van productieorderrregel 1 op productieorder 54321. Het aanmaken/wijzigen/verwijderen van losse records is wel mogelijk, maar wordt al gauw complex.
• Voorlopig is de MKG API niet in de MKG cloudomgevingen beschikbaar.
• De MKG API is in de basis niet bedoeld voor het vullen van datawarehouses en uitvoeren van datareplicatie.
• Excessief gebruik van de MKG API kan gevolgen hebben voor de algehele performance van MKG. De consequenties liggen niet altijd bij MKG (denk aan inefficiënte query’s, veel data).
• Gebruik de API zo efficiënt mogelijk, bijvoorbeeld daar waar echt behoefte is aan real time data. Import-/exportkoppelingen hebben de voorkeur bij grote datasets die niet real time hoeven.

Implementatie en ondersteuning

De MKG API is RESTful opgezet. Dit is een wereldwijde API-protocol-standaard met basisprincipes. Een ontwikkelaar met enige API-kennis kan hiermee eenvoudig aan de slag.

MKG bouwt zelf geen applicaties, maar kan wel ondersteuning bieden. Zo kunnen we bijvoorbeeld nagaan welke query nodig is om bepaalde informatie uit MKG te halen.

Ook laten we weten hoe verbinding kan worden gemaakt met de API en welke informatie kan worden uitgewisseld. Deze uitleg is vastgelegd in onze API-documentatie die we ter beschikking stellen wanneer de MKG API geïmplementeerd wordt in je bedrijf.

MKG Exchange licentie

De MKG API maakt deel uit van de MKG Exchange licentie. Deze licentie is nodig bij het gebruik van geautomatiseerde data-uitwisseling of toegang tot de database (zoals met de MKG API). Deze licentie heeft de volgende toegangsvormen:

• géén toegang
• leestoegang
• lees- en schrijftoegang

Heb je interesse in de API? Neem dan contact op met je contactpersoon binnen MKG.