Introduction to the MKG API

API stands for Application Programming Interface. An API is a means, a set of instructions, to connect programs or software, allowing data to be exchanged. A major advantage of an API is that data is transferred real-time over the internet. There is no physical file exchange, as with an import and export link.

How does the MKG API work?

The MKG API enables MKG and another software program to communicate with each other via the internet. This is done through the web server. The REST model (REpresentational State Transfer) is the standard model for formatting the messages exchanged according to the HTTP standard:

• GET = request data
• PUT = update data
• POST = create data
• DEL = delete data

The initiative for communication lies with the other software program. The MKG API only facilitates the transfer of data and execution of actions between MKG and the other software program. For example: the completion of a specific production order can be given as an 'assignment' via the API. The API listens to this and executes it in the background within MKG.

In principle, everything needs to be programmed once, after which the data can be exchanged continuously. Through mapping, a translation must be made between the program to be connected and MKG, as not everything is entered in the same way and the fields will not completely match the fields of MKG. For instance, it is set up that the data from field A of the program must be placed in field B in MKG in a specific format.

Example: Requesting relations

GET {{restUrl}} /MKG/Documents/rela

Example: Requesting relation 1

GET {{restUrl}} /MKG/Documents/rela/1

Example: Requesting addresses of relation 1

GET {{restUrl}} /MKG/Documents/rela/1/rela_adrs

Example: Requesting address 1 of relation 1

GET {{restUrl}} /MKG/Documents/rela/1/rela_adrs/1

The response is returned in a standardized data format, the JSON format.

What can the API be used for?

In general, the underlying (API) technology has endless possibilities. However, for the MKG API, the basis is that it can function as an external MKG user. We strive for the API to have the same functionalities as an Office user in MKG. Some examples of using the MKG API in business include:

• Connecting a webshop to MKG. From the webshop, for example, sales order data can be transferred to MKG via the API.
• Connecting machines to MKG. On the shop floor, machines can report hours and/or quantities to MKG. They can also request planning data from MKG.
• Connecting design programs, such as CAD software, to MKG. The design program can retrieve materials/items from MKG via the API to link to a drawing, after which it can be returned to MKG with a drawing or revision number.
• Connecting your own telephone exchange to MKG, so that relationship and contact details are synchronized.

Additional information for developers

• The functions (services) and tables are released in phases.
• It is preferred to use function calls for process-driven actions, for example, reporting the completion of production order line 1 on production order 54321. Creating/modifying/deleting individual records is possible but quickly becomes complex.
• For now, the MKG API is not available in the MKG cloud environments.
• The MKG API is not primarily intended for populating data warehouses and performing data replication.
• Excessive use of the MKG API can affect the overall performance of MKG. The consequences do not always lie with MKG (consider inefficient queries, large amounts of data).
• Use the API as efficiently as possible, for example, where there is a real need for real-time data. Import/export links are preferred for large datasets that do not need to be real-time.

Implementation and support

The MKG API is set up RESTful. This is a global API protocol standard with basic principles. A developer with some API knowledge can easily get started with it.

MKG does not build applications itself but can provide support. For example, we can determine which query is needed to retrieve specific information from MKG. We also inform you how to connect to the API and what information can be exchanged. This explanation is documented in our API documentation, which we provide when the MKG API is implemented in your company.

MKG Exchange License

The MKG API is part of the MKG Exchange License. This license is required for automated data exchange or database access (such as with the MKG API). This license has the following access forms:

• no access
• read access
• read and write access