Welcome to TSG Client’s documentation!

TSG Client is a Python library for interacting with the TNO Security Gateway (TSG). It is current version, it is a simple REST API client that interacts with TSG Core Connector APIs and TSG OpenAPI Data APP. It provides a simple and easy-to-use interface for tasks such as:

• Connecting to a TSG core container (via API KEY)

• Retrieving connector self-descriptions

• Parsing / filtering connector catalogs and artifacts, retrieved from self-descriptions

• Requesting and consuming data artifacts (via dataspace)

• Queries to the dataspace Metadata Broker to list registered connectors and respective self-descriptions

• Perform requests via OpenAPI Data APP

This document provides detailed instructions for setting up the INESC TEC Client for TNO Security Gateway (TSG-Client) environment. Please follow these steps carefully to ensure successful configuration and deployment.

Contents:

• Getting Started with the TSG Client
  • Overview
  • Installation steps
• FAQ
• Contacts

Code Examples:

• Examples
  • Connection to Our TSG Connector
  • Get self-description description of your connector
  • Get external self description
  • Get external catalogs
  • Get external artifacts
  • Get Contract Agreement and Download Artifact
  • Post artifact
  • Edit artifact
  • Delete artifact
  • Get external open API specs
  • External open API request
  • Get self-descriptions from connectors registered in the Metadata Broker
• Module contents

Indices and tables

• Index

• Module Index

• Search Page