Torna all'Applicazione

Guida all'Enrollment TeamSystem

Tutto quello che devi sapere per utilizzare correttamente l'API di Enrollment

Cos'è l'Enrollment?
L'Enrollment è il processo di registrazione e censimento di un cliente e dei suoi prodotti nell'ecosistema TeamSystem. Attraverso questa procedura ottieni le credenziali (Client ID e Client Secret) necessarie per integrare i tuoi sistemi con le API TeamSystem.

Indice dei Contenuti

Panoramica del Processo

Il processo di Enrollment si articola in tre fasi principali:

1

Identificazione del Cliente

Fornisci i dati identificativi del cliente attraverso almeno uno dei seguenti:

  • OID Company: GUID univoco dell'azienda in ACA (Anagrafica Centralizzata delle Aziende)
  • Partita IVA: Codice fiscale dell'azienda
  • Codice Fiscale: Per persone fisiche o identificazione alternativa
2

Configurazione Prodotti

Specifica i prodotti da associare al cliente:

  • Tipo di Impianto: IAAS, SAAS o ON PREMISES
  • Product Registry: Identificativi del prodotto nella gerarchia TeamSystem
  • Procedure OID: Identificativo obbligatorio della procedura
3

Ottenimento Credenziali

Ricevi le credenziali per l'integrazione:

  • Client ID: Identificativo pubblico del client
  • Client Secret: Chiave segreta per l'autenticazione

Ambienti di Test e Produzione

Importante: Utilizza sempre l'ambiente di test per le prove e lo sviluppo. Passa alla produzione solo quando tutto è pronto e testato.

🧪 Ambiente di Test

POST https://development.teamsystem.com/api/enrollment
  • Utilizzato per sviluppo e test
  • Dati non vincolanti
  • Possibilità di fare molteplici prove
  • Credenziali generate non valide per produzione

🚀 Ambiente di Produzione

POST https://api.teamsystem.com/api/enrollment
  • Utilizzato per operazioni reali
  • Dati vincolanti e persistenti
  • Credenziali valide per l'integrazione effettiva
  • Richiede dati clienti reali e verificati

Guida Passo-Passo

Come utilizzare l'applicazione:

1

Selezione Ambiente

Scegli l'ambiente appropriato:

  • 🧪 Test: Per prove e sviluppo
  • 🚀 Produzione: Per operazioni reali
2

Compilazione Host Name

Inserisci l'identificativo del tuo ambiente (es. mycompany.com)

3

Dati Cliente

Compila almeno uno dei seguenti campi:

  • OID Company: Se hai il GUID dell'azienda
  • Partita IVA: Formato: IT + 11 cifre
  • Codice Fiscale: 16 caratteri
4

Configurazione Prodotti

Per ogni prodotto da registrare:

  • Seleziona il Tipo di Impianto (obbligatorio)
  • Inserisci il Procedure OID (obbligatorio)
  • Compila gli altri campi del Product Registry se disponibili
  • Usa "Aggiungi Prodotto" per registrare più prodotti
5

Invio e Risultato

Clicca "Invia Enrollment" e:

  • Attendi il completamento della richiesta
  • Copia Client ID e Client Secret dal risultato
  • Conserva le credenziali in modo sicuro

Riferimenti API

Endpoint Ufficiale

La documentazione completa è disponibile su:

TeamSystem Developer Guide - Enrollment Registration

Struttura della Richiesta

{ "hostName": "string", "customer": { "company": { "oid": "guid-opzionale", "vatCode": "string-opzionale", "fiscalCode": "string-opzionale" } }, "productConfigurations": [ { "type": "IAAS|SAAS|ON PREMISES", "productRegistry": { "familyOid": "guid-opzionale", "productOid": "guid-opzionale", "procedureOid": "guid-obbligatorio", "versionOid": "guid-opzionale", "versionName": "string-opzionale", "moduleOid": "guid-opzionale" } } ] }

Risposta di Successo

{ "clientId": "string", "clientSecret": "string", // ... altri campi }

Headers Richiesti

Content-Type: application/json Accept: application/json

Guida Dettagliata ai Campi

Campi Customer

Campo Tipo Obbligatorio Descrizione Esempio
hostName String Sì Identificativo dell'ambiente di provenienza mycompany.com
company.oid GUID Opzionale* GUID della Company in ACA 12345678-1234-1234-1234-123456789012
company.vatCode String Opzionale* Partita IVA del cliente IT12345678901
company.fiscalCode String Opzionale* Codice fiscale del cliente RSSMRA80A01H501Z

* Almeno uno dei tre campi company deve essere compilato

Campi Product Configuration

Campo Tipo Obbligatorio Descrizione Valori Ammessi
type String Sì Tipo di impianto IAAS, SAAS, ON PREMISES
productRegistry.familyOid GUID No Identificativo famiglia prodotto GUID format
productRegistry.productOid GUID No Identificativo prodotto GUID format
productRegistry.procedureOid GUID Sì Identificativo procedura GUID format
productRegistry.versionOid GUID No Identificativo versione GUID format
productRegistry.versionName String No Nome versione (alternativa a versionOid) v1.0.0, v2.1.0
productRegistry.moduleOid GUID No Identificativo modulo specifico GUID format

Esempi Pratici

Esempio 1: Enrollment Completo

{ "hostName": "mycompany.development.local", "customer": { "company": { "oid": "12345678-1234-1234-1234-123456789012", "vatCode": "IT12345678901", "fiscalCode": "RSSMRA80A01H501Z" } }, "productConfigurations": [ { "type": "SAAS", "productRegistry": { "familyOid": "11111111-1111-1111-1111-111111111111", "productOid": "22222222-2222-2222-2222-222222222222", "procedureOid": "33333333-3333-3333-3333-333333333333", "versionOid": "44444444-4444-4444-4444-444444444444", "versionName": "v1.0.0", "moduleOid": "55555555-5555-5555-5555-555555555555" } } ] }

Esempio 2: Enrollment Minimale

{ "hostName": "testclient.example.com", "customer": { "company": { "vatCode": "IT98765432109" } }, "productConfigurations": [ { "type": "IAAS", "productRegistry": { "procedureOid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" } } ] }

Esempio 3: Multi-Prodotto

{ "hostName": "enterprise.company.com", "customer": { "company": { "oid": "99999999-9999-9999-9999-999999999999" } }, "productConfigurations": [ { "type": "SAAS", "productRegistry": { "procedureOid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa", "versionName": "v2.0.0" } }, { "type": "ON PREMISES", "productRegistry": { "familyOid": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb", "productOid": "cccccccc-cccc-cccc-cccc-cccccccccccc", "procedureOid": "dddddddd-dddd-dddd-dddd-dddddddddddd", "moduleOid": "eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee" } } ] }

Risoluzione Problemi

Errori Comuni e Soluzioni

❌ "È necessario compilare almeno uno dei campi Company"
Soluzione: Compila almeno uno tra OID Company, Partita IVA o Codice Fiscale.
❌ HTTP 400: Bad Request
Possibili cause:
  • GUID malformati (devono essere nel formato: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
  • Tipo di impianto non valido (usa esattamente: IAAS, SAAS, "ON PREMISES")
  • Campi obbligatori mancanti
❌ HTTP 401: Unauthorized
Soluzione: Verifica di aver selezionato l'ambiente corretto e che l'endpoint sia raggiungibile.
❌ Errore CORS
Soluzioni:
  • Usa Live Server invece dell'apertura diretta del file
  • Configura il browser per disabilitare CORS in development
  • Usa un server web locale

Verifica dei Dati

✅ Checklist prima dell'invio:
  • Ambiente selezionato correttamente
  • Host Name compilato
  • Almeno un campo Customer compilato
  • Tipo di impianto selezionato
  • Procedure OID inserito
  • GUID nel formato corretto
  • Nessun carattere speciale nei nomi

Formati Corretti

Tipo Formato Esempio
GUID xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx 12345678-1234-1234-1234-123456789012
Partita IVA IT + 11 cifre IT12345678901
Codice Fiscale 16 caratteri alfanumerici RSSMRA80A01H501Z
Tipo Impianto Valori esatti IAAS, SAAS, ON PREMISES

Contatti e Supporto

📞 Supporto Tecnico:
Per problemi tecnici specifici dell'API TeamSystem, consulta la documentazione ufficiale o contatta il supporto TeamSystem.

🔗 Risorse Utili:

Questa guida è stata creata per facilitare l'utilizzo dell'API TeamSystem Enrollment.

Torna all'Applicazione