Endpoints

What is an Endpoint

Endpoints in the Data Hub refer to specific URLs or API routes that allow users or systems to interact with Data Collections, execute operations, or access services provided by the platform. Each Endpoint represents a distinct function or resource, such as retrieving data, updating records, or executing a query. Endpoints are designed to facilitate smooth communication between external applications and the data stored within the Data Hub.

The key benefits of Endpoints include enabling seamless integration with external systems, providing a structured and organized way to interact with data, and allowing developers to build efficient, automated workflows. By exposing specific API Endpoints, you can define how users or systems can access and manipulate your data, whether it’s for querying, inserting, updating, or deleting information.

Export Endpoint

The Export Endpoint is connected to a single Data Collection and provides multiple Access Points, each with its own unique API Key for secure access. Its focus is to manage who can access the Endpoint and what user retrieve when accessing the Endpoint. Each Access Point can be customized with a Filter and a Formatting, allowing users to retrieve only the relevant data they need in the desired format. This ensures that different users or systems can access the same Data Collection over the same Endpoint but with varying levels of granularity or structure, based on their individual requirements which can be controlled via the API Key. The Export Endpoint provides flexibility for customized data extraction, all while ensuring secure, controlled access through the use of unique API Keys.

Import Endpoint

The Import Endpoint functions similarly to the Export Endpoint, but with a focus on uploading files to importing its content into a Data Collection. In the case of the Import Endpoint, you can connect multiple Data Collections to the Endpoint for importing data. However, the specific collection into which the data should be imported must be explicitly defined in the query if you select more than one Data Collection. You can also define multiple Access Points via an API Key per Endpoint, each of which can have its own Filter and Formatting. The Filter ensures that only valid data is imported into the Data Collection, allowing you to control which data is included based on specific criteria like expire dates. This helps maintain data integrity by preventing invalid or irrelevant information from being imported. The Formatting transforms the data in the uploaded file into the schema of the target Data Collection. This ensures that the incoming data matches the expected structure and format of the collection, making it compatible with the system’s database. By combining Filters and Formatting with each access point, you can streamline the import process, ensuring that the right data is imported in the correct format and structure, maintaining consistency across your collections.

Navigation to the Endpoints page

To get to the Endpoint page from the dashboard, find the Data Hub Tile and select Endpoints.
If the tile shown is deactivated, you do not yet have a Data Hub license. In this case, please contact sawsconnector@saws.de.

If you are not on the dashboard click the most left button in the toolbar to navigate to the dashboard page.

If you are already in the Data Hub you can use the dropdown menu in the toolbar and select the Endpoints item.

Now you should be in the Endpoints page which shows the Endpoints table list.

Navigation through the Wizard

To navigate in the wizard use the Back and Next button in the bottom right corner or directly press on the step you want to navigate to.

The current step you are currently in is marked in orange. If a step has a x icon some data in the current step is not valid.

Any change made in the wizard is only stored when you click the save button in the overview step.

Creating an Export Endpoint

To create a new Export Endpoint, click on the Plus Button on the top left corner of the Endpoints table.

The Endpoint wizard will open where you have to go through multiple steps to create your Export Endpoint:

• Endpoint
• Data Collection
• Access Point
• Overview

 

Endpoint

In this step, you define the Endpoint URL, which determines where your data will be accessible. The Endpoint is the unique web address that clients will use to retrieve data. The Endpoint acts as the entry point for your data, allowing external systems or applications to access information from your Data Collection. Choosing a clear and structured URL makes it easier to manage and use later. The Endpoint can only consist of the following characters: A-Z, a-z, 0-9, -, _, ., !, ~, *, ', (, ). As type select the Export type. forth

Below you see the URL you can use to fetch the data from the Endpoint in a program.

Under the URL is a table with every API Key which is already connected to the Endpoint you defined. Every API Key can only be once connected to an Endpoint URL. The table lets you verify that the API Key which you are going to use is not already in use in this Endpoint.

In this example the API Key Public (Owl) is already connected to the Endpoint my-export-endpoint and can not be assigned again to this Endpoint.

Data Collection

In the Data Collection step you select a Data Collection which the Endpoint is connected to. If you do not have any Data Collections or want to connect a new Data Collection you can create a new Data Collection with the Create Data Collection button. This will open the Data Collection editor in the wizard.

Below you see a table which shows all Access Points with the same Endpoint URL and Data Collection. Every entry in the table is also added in the wizard navigation. This is a reminder that these API Keys are already associated with this Endpoint URL. The wizard always shows every Access Point in the navigation which have the same Endpoint URL and Data Collection.

Access Point

In the Access Point step you have to select an API Key, a Filter and a Formatting.

API Key

The API Key is the identifier of the Access Point and thus can only be assigned once to every Export Endpoint URL.
You can create an API Key in the wizard using the Create API Key button.

Filter

The Filter is applied before the Formatting. You can use the Filter to refine, modify or limit the data retrieved from the Endpoint.
You can create a new Filter using the Create Filter button.

Formatting

With the Format you can transform the data from the Data Collection into another shape and/or format like CSV or XML.
You can create a new Format using the Create Formatting button. An Export Endpoint expects a Document Format.

Sync Status

Sows the current synchronization status of your Access Point.
This field is only visible for already created Access Points.
For more information read the Sync Status article.

Delete Access Point

At the bottom left you can delete an Access Point via the Delete Access Point button. The deletion is only finalized when you click the Save button in the Overview step.

Overview

In the overview you can check your applied changes. An Access Point can either be Added, Deleted or Changed.
The counterclockwise arrow in a Delete Access Point removes the deleted Access Point from the change list and will not be delete when you press Save.
The trash can in a Added Access Point removes the added Access Point from the change list and will not be created when you press Save.
The pencil in a Changed Access Point navigates to the changed Access Point step.
Every data that got changed is marked with an arrow and follows the syntax “from → to”.
If you change the Data Collection it is changed for every Access Point you see in the wizard navigation.
You can add a new Access Point using he Add Access Point button.
The Browser button leads to the Export Browser. Be careful, every unsaved change will get lost.

Creating a Import Endpoint

The creation of a Import Endpoint is the same as for the Export Endpoint. There are just a few differences.

Endpoint

In the Endpoint step you have to select the type Import to create an Import Endpoint.

Data Collection

Instead of one you can select multiple Data Collection which are connected to the Import Endpoint.

Access Point

The API Key is also here the identifier of the Access Point and thus can only be assigned once to every Import Endpoint URL.
A Import Endpoint expects a Import Format.

Was this article helpful?

0 0

How can we improve this article?

Please submit the reason for your vote so that we can improve the article.

Name

Email

Submit