Skip to main content
Version: 1.006.000

Glossary

If you are new to the world of TSE in Cloud, you might feel overwhelmed by the amount of information available in this documentation.

That’s why we suggest starting by learning what we are talking about: we believe the first step is to become familiar with the terms used by the TSE in Cloud API.

Common Terms​

Below you can find a list of the fundamental concepts you need to know:

CID​

The customer identification is uniquely assigned to each client.

For example: csdemo

APIGateway​

An API Gateway is a protection point for API access, which secures and manages traffic between API consumers and the applications exposing those APIs.

Using an API Gateway provides several benefits, ensuring:

  • Authentication and authorization;
  • Routing to backends;
  • Rate limiting to prevent system overload and protect against DDoS attacks;
  • SSL/TLS traffic offloading to improve performance and handle errors or exceptions;
  • Tracking and monitoring resource access;

TSE APIs intended for integration are exposed downstream of the Teamsystem PaaS API Gateway.

API Gateway

Simplified schema for API Gateway access with Nginx

webapi_base_url​

This is the URL used to connect to the application (interface). It has a structure similar to:

webapi_base_url: [protocol]://[cid].domain

For example https://csdemo.teamsystem.io

apigwt_base_url​

This is the URL used to connect to the services (RESTful). It has a structure similar to:

apigwt_base_url:  https://api + [webapi_base_url]/api

It always has a prefix api+cid.

For example:

  • https://apicsdemo.teamsystem.io/api/swagger/docs/index.html , to access the Swagger documentation;

  • https://{{apigwt_base_url}}/api/v1/{{scope}}/CO/CustomerSupplierCo/search?company=2 , to access the customer/supplier search service.

Scope​

Also referred to as [environment], it represents the set of data you have access to. Although other configurations are possible in Teamsystem Enterprise Cloud, each installation has access to only one environment.

Resource​

It is the name of the REST resource assigned to the application entity; it is used in the REST call.

For example:

{{apigwt_base_url}}/api/v1/{{scope}}/CO/CustomerSupplierCo/search?company=2

oData​

The Open Data Protocol (OData) is a data access protocol built on core protocols like HTTP and commonly accepted methodologies like REST for the web https://www.odata.org.