FAQs
Quale metodo di autenticazione dovrei usare?
Per iniziare a lavorare con le nostre API, devi utilizzare Token di sessione. Abbiamo creato una guida più estesa alla selezione del metodo di autenticazione per aiutarti a scegliere quello che utilizzerai quando andrai in produzione.
Come posso scaricare i file swagger in formato .yaml?
Per scaricare i file in formato .yaml, puoi semplicemente cliccare sul link di riferimento in swagger, es: https://apicsdemo.teamsystem.io/swagger/v1_IntegrationInfrastructure/swagger.json e rinominare l'estensione in https://apicsdemo.teamsystem.io/swagger/v1_IntegrationInfrastructure/swagger.yaml
Dove posso trovare il mio Company_ID?
Il Company_Id è un parametro molto importante per le WebAPI di TSE in Cloud perché consente all'utente di utilizzare i metodi con ambito aziendale. Per il recupero del companyID vai al seguente link.
Che cosa si deve fare in caso di messaggi di errori warning ?
Per forzare e non considerare un warning nell'esecuzione di un servizio è necessario aggiungere il parametro 'force' nella chiamata. Il parametro 'force' richiede l'elenco dei codici di warning che non si vogliono considerare (force=97788,97760) o del singolo warning. Per individuare l'elenco dei codici warning è necessario richiamare il servizio senza il suddetto parametro. Se in fase di inserimento di un'anagrafica tramite POST, è riportato nella response "warningCode": 97788, è necessario aggiungere il parametro "&force=97788".
Posso schedulare i miei task in cloud?
Sì, è possibile!
A partire dalla versione 2025001000, è possibile schedulare i propri task in TSE Cloud.
È sufficiente seguire la stessa procedura utilizzata nella versione on-premises.
NON TUTTI I TASK SCHEDULABILI ON-PREM LO SONO IN CLOUD
La procedura di schedulazione è stata modificata per consentire di schedulare solo i processi compatibili con l'ambiente Cloud.
Le schedulazioni configurate, che on-premises sono gestite dallo scheduler del sistema operativo, in Cloud rientrano nei processi standard di schedulazione e sono visibili nella landing page dei processi schedulati.
Sono stati messi a disposizione due nuovi servizi per supportare la schedulazione in Cloud:
- Un servizio web che esegue gli insiemi presenti nella pianificazione. Puoi trovare un esempio qui. Questo servizio consente di "forzare" l'esecuzione di una pianificazione o di spostare l'esecuzione sul proprio client, delegando a quest'ultimo la parte di pianificazione.
- Un insieme di servizi per il download e l'upload dei file in Cloud, da includere eventualmente nelle azioni schedulate. Alcuni esempi sono disponibili qui.
Cartelle temporanee
Lo scambio dati avviene su una directory temporanea in Cloud, che non è da considerarsi consistente per la conservazione dei file, in quanto è prevista una rimozione automatica temporizzata.
Questi servizi permettono di replicare le modalità di schedulazione basate su file di scambio su cartelle locali, in modo semplice e immediato.
A scopo dimostrativo, viene fornito un esempio in PowerShell che consente di effettuare lo scambio dei file da e verso il Cloud senza dover scrivere codice.
Il file PowerShell è schedulabile in sostituzione del file .bat generato automaticamente sui servizi Windows on-premises. La schedulazione in Cloud sarà poi in grado di processare i file per importare o esportare i dati richiesti.
E' possibile escludere gli Agenti Multipli memorizzati sul cliente?
Tramite la proprietà callOptions con il parametro 'EsclusioneAgentiMultipli' è possibile escludere
o meno gli agenti multipli del cliente.
Se il parametro 'EsclusioneAgentiMultipli=true', il sistema considererà i soli agenti passati in
DocumentoTestataAgentiMG, ignorando quelli proposti da configurazione cliente.
Per maggiori dettagli, vai all'esempio
Come generare la stampa pdf?
Per consentire la stampa in pdf di un documento, è possibile recuperare con una GET, tramite il comando Print lo streamPDF di un documento che sarà decodificato e convertito in PDF tramite un qualsiasi programma di conversione. Per maggiori dettagli vai al seguente esempio
Posso sviluppare la mia integrazione on prem. senza dover cambiare successivamente il codice passando al cloud?
Certo! Anche in ambiente on-premises puoi utilizzare l'autenticazione tramite token.
Effettua la chiamata di autenticazione specificando "password" come grant_type anziché "token" e inserisci la password che utilizzi per le chiamate on-premises.
In questo modo, potrai utilizzare il token di sessione simulando le stesse chiamate che in ambiente cloud richiedono obbligatoriamente il token.
E' possibile inserire un documento di vendita, senza indicare il codice articolo di magazzino ma specificando l'Articolocliente ?
Certo! Basta indicare nel Body della chiamata POST al posto di codartMg66 l'entità codartcli, come qui di seguito riportato:
{
"righe": [
{
"progrRiga": 1.0,
"codartcli": "ARTCLI124500",
"qta1": 1.000
}
}
E' possibile passare da uno StatoAttuale a NULL ad uno StatoAttuale valorizzato, tramite PUT oppure PATCH ?
NO. La chiamata PUT o PATCH non permette di settare lo stato iniziale di un flusso. Presa in considerazione una determinata entità, per poter passare da uno StatoAttuale NULL allo stato Predefinito, è necessario utilizzare il servizio StateManagementService e l'azione 'setstate'.
Con la chiamata PUT o PATCH è possibile passare da uno stato ad un'altro, ma deve essere valorizzato almeno lo stato iniziale del Flusso. Inoltre il passaggio deve essere coerente e consecutivo, per cui si devono tenere conto gli Stati Disponibili e l'avanzamento secondo il Flusso predefinito. Per esempio preso in considerazione un documento che è nello StatoAttuale = "idStato": 40 (come da json sotto indicato) si può passare allo stato successivo "idStato": 41 che è lo stato consecutivo, previsto dal flusso, ma non si può passare allo StatoAttuale 43.
{
"statoAttuale": {
"statoCorrente": {
"idStato": 40,
"seq": -1,
"indTipoStato": 0,
"extensionData": [],
"additionalData": {}
},
"statiDisponibili": [
{
"idStato": 40,
"seq": 1,
"indTipoStato": 0,
"extensionData": [],
"additionalData": {}
},
{
"idStato": 41,
"seq": 2,
"indTipoStato": 0,
"extensionData": [],
"additionalData": {}
},
{
"idStato": 42,
"seq": 3,
"indTipoStato": 0,
"extensionData": [],
"additionalData": {}
},
{
"idStato": 43,
"seq": 4,
"indTipoStato": 0,
"extensionData": [],
"additionalData": {}
},
{
"idStato": 44,
"seq": 5,
"indTipoStato": 0,
"extensionData": [],
"additionalData": {}
}
],
},
}
Come posso popolare il campo CodSede (DO11_CODSEDE_CG31) presente nel DTO DocumentoTestataMGDTO?.
Il codice sede deve essere definito all'interno del campo officeCO per la TestataDocumento e nel corrispondente campo officeCO per la RigaDocumento interessata. Se il codice sede della riga è diverso da quello della testata, è necessario specificarlo nel body della chiamata. Ad esempio, è possibile indicare il codice 1 per la "Sede aggiuntiva" nella TestataDocumento e il codice 2 per la "Sede Pesaro" nella RigaDocumento, come mostrato di seguito:
Per la TestataDocumento:
{
"officeCO": {
"cap": "47900",
"citta": "Rimini",
"codice": 1.0,
"dittaCg18": 1000.0,
"idmediaCg99": null,
"indDimcentrocomm": 0.0,
"indIrizzo": "Sede aggiuntiva",
"numerorea": null,
"progRea": null,
"prov": "RN",
"rowversion": "AAAAAAAc51s="
}
}
Per la RigaDocumento:
{
"officeCO": {
"cap": "",
"citta": "Pesaro",
"codice": 2.0,
"dittaCg18": 1000.0,
"idmediaCg99": null,
"indDimcentrocomm": 1.0,
"indIrizzo": "Sede Pesaro",
"numerorea": null,
"progRea": null,
"prov": "RN",
"rowversion": "AAAAAAAcT+U=",
"extensionData": [],
"additionalData": {}
}
}