Skip to content
This repository has been archived by the owner on May 2, 2024. It is now read-only.

Latest commit

 

History

History
43 lines (25 loc) · 1.85 KB

README.md

File metadata and controls

43 lines (25 loc) · 1.85 KB

Tributech DataSpace Kit Twin API client

This repository contains the Twin API client for easy access to the twin-api of the Tributech DataSpace Kit.

Integration via API

The client can be used to connect an application to the twin api of the Tributech Dataspace Kit endpoints.

Authentication / Authorization

You will need to to provide proper authorization in order to access the APIs. You can do this through client credentials authentication through the Keycloak server deployed at the hub of your ecoystem. Check out the example for how to do this in C# through the ready to use ApiAuthHandler which we provide. Also read the detailed guide for usage of the .NET Core clients for more info.

Essentially, you will need to provide the following parameters:

Parameter Value Remark
tokenUrl https://auth.your-hub.dataspace-hub.com/auth/realms/your-node/protocol/openid-connect/token Url to retrieve the access token from the dataspace hub Keycloak Server
scope profile / email / twin-api / catalog-api / node-id Defines the scope of what can be accessed
clientId your-api-specific-client-id Can be found in the Dataspace Admin (Profile -> Administration)
clientSecret your-api-specific-client-secret Can be found in the Dataspace Admin (Profile -> Administration)

Usage

Usage examples for the clients are available in /examples.

You can inspect the availabe endpoints for the Twin API Api through Swagger. Please follow the guide on docs.tributech.io.


Contribute

Please report any bugs / issues that you find, thank you!


Need Support?

Use the Tributech Support Center.