Passa al contenuto principale
Versione: 2025.003.000 (beta)

Glossary

Se sei un principiante nel mondo del TSE in Cloud, probabilmente ti sentirai sopraffatto dalla quantità di informazioni che puoi trovare in questa documentazione.

Ecco perché ti suggeriamo di iniziare imparando di cosa stiamo parlando: pensiamo che il primo passo sia familiarizzare con i termini utilizzati dall’API TSE in Cloud.

Termini Comuni​

Di seguito puoi trovare un elenco dei concetti fondamentali che devi conoscere:

CID​

L’identificazione del cliente è assegnata in modo univoco a ciascun cliente.

Per esempio csdemo

APIGateway​

Un API gateway è un punto di protezione per l'accesso alle API, che protegge e gestisce il traffico tra gli utilizzatori delle API e le applicazioni che espongono quelle API.

Adottare un API gateway offre diversi vantaggi, garantendo:

  • L'autenticazione and autorizzazione;
  • L'instradamento ai backend;
  • La limitazione della velocità per evitare il sovraccarico dei sistemi e proteggere dagli attacchi DDoS;
  • Lo scarico del traffico SSL/TLS per migliorare le prestazioni e gestire errori o eccezioni;
  • Il tracciamento e monitoraggio dell’accesso alle risorse;

Le API TSE destinate all’integrazione sono esposte a valle del Teamsystem PaaS API Gateway..

API Gateway

Schema semplificato accesso API Gateway con Nginx

webapi_base_url​

Questo È l’URL a cui ci si connette per accedere all’applicazione (interfaccia), ha una struttura simile a

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

Per esempio https://csdemo.teamsystem.io

apigwt_base_url​

Questo È l’URL a cui ci si connette per accedere ai servizi (RESTful), ha una struttura simile a

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

Ha sempre un prefisso api+cid.

Per esempio:

  • https://apicsdemo.teamsystem.io/api/swagger/docs/index.html , per accedere alla documentazione su Swagger;
  • https://{{apigwt_base_url}}/api/v1/{{scope}}/CO/CustomerSupplierCo/search?company=2 , per accedere al servizio search dei clienti/fornitori.

Scope​

Anche indicato come [environment] rappresenta l'insieme di dati ai quali hai accesso; sebbene siano possibili altre configurazioni in Teamsystem Enterprise Cloud, ogni installazione ha accesso ad un solo environment.

Risorsa​

È il nome della risorsa REST assegnato all’entità dell’applicazione; viene utilizzato nella chiamata REST.

Per esempio:

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