Create an Interface

Introduction

The interfaces represent your applications which are allowed to connect with our API. You can connect various applications with different settings and data-structures.

Create a new interface

Creating a new interface in just a few steps:

  1. Fill in a unique name and description of your application, the name of the application is mandatory and will be used in the Header of the API.
  2. There are some settings to determine the Authorization of your Application.
    • Within the Authorization you have to whitelist IP-addresses of your application. These IPs can be IPv4 or an IPv6. Also, you can insert a range of IPs. With this, you are permitting those addresses to use your application. You can separate every single address, using a comma.
    • OAuth2 enabled: On this input, we can switch between the protocol OAuth2 enable or not. This field depends on the application that you want to create and which authorization system it is using.
    • The type of application: You can select between “Desktop”, “Mobile” and “Server”.
    • Within the scopes available you can select the options of operations that an application can perform using the API.
  3. The Incoming Request you determine in which structure the records will be delivered to the API. This can be as the Global Data Schema or as a Personal Data Schema.

 

 

When the data structure is different than the Data Schema you’ve set, you have to select the Personal Data Schema, this means that you have to Map the data from the application to the data of the Data Schema you have set in the platform.

By clicking on New Mapping you can set your data structure in three different ways:

  • You can Upload an JSON or XML file;
  • You can Paste your JSON or XML structure;
  • You can start adding fields in the editor one-by-one;

After that you can Map the Application Data Schema to the Global Schema. This can be done by pressing Match to match the variables by the same name or do it by matching them one-by-one.

  1. The response of the API can be set as default by selecting the default Outgoing Structure or create your Personal Outgoing Structure. Here you can determine your Success and Error Response.

Save the Interface

After saving the Interface your Application is now connected to the API via the Interface.