Skip to main content

Flowlyze Client

Questo pacchetto contiene un client API per interagire con i flow e le destination di Flowlyze.

L'id del pacchetto è Ipaas.ApiClient.

Per l'installazione ricordarsi di specificare la sorgente locale dei pacchetti nuget come da documentazione.

Per scaricare il pacchetto, cliccare qui;

Installazione​

Installare il pacchetto nuget Ipaas.ApiClient nel progetto e aggiungere il client alla DI con uno dei seguenti metodi:

// Aggiunge IpaasClient alla DI. La sezione di configurazione sull'appsettings.json deve chiamarsi "Ipaas"
services.AddIpaasClient(configuration) /* IConfiguration configuration */

// Aggiunge IpaasClient alla DI andando a specificare il nome per la sezione configurazione persente sull'appsettings.json
services.AddIpaasClient(configuration, sectionName) /* IConfiguration configuration, string sectionName */

// Aggiunge IpaasClient alla DI andando a specificare direttamente le azioni da eseguire sulle opzioni di configurazione senza l'utilizzo dell'appsettings.json
services.AddIpaasClient((options) => {...})) /* Action<IpaasOptions> action */

// Aggiunge IpaasClient alla DI andando a specificare direttamente le opzioni di configurazione senza l'utilizzo dell'appsettings.json
services.AddIpaasClient(options) /* IpaasOptions options */

IpaasOptions​

Questa classe contiene le seguenti proprietà e sono tutte obbligatorie per la corretta configurazione del client:

  • ApiUrl : indica la URL di Flowlyze
  • ApiKey : indica la chiave di autenticazione
  • TenantId : indica il tenant su cui agire

Utilizzo​

Una volta registrato nella DI, sarà possibile utilizzare il client nel proprio servizio semplicemente richiedento la classe IpaasClient nel costruttore.

Andiamo adesso nel dettaglio dei metodi disponibili per l'interazione con Flowlyze.

Flow​

GetAllFlowsAsync​

Questo metodo è utilizzato per recuperare in maniera asincrona tutti i flow presenti nel tenant.

Fra i parametri opzionali, è possibile specificare un filtro per recuperare solo i flow che soddisfano determinate condizioni.

La struttura dell'oggetto da utilizzare per recuperare tutti i flow con un determinato name è la seguente:

{
    "requestAll": true,
    "filter": [
        {
            "name": "name", // id, name
            "comparator": "equal", // equal, notEqual, contains, notContains
            "value": "flowName", // the actual value to compare
            "caseSensitive": false, // true, false
            "operator": "and" // and, or
        }
    ]
}

GetFlowByNameAsync​

Questo metodo è utilizzato per recuperare in maniera asincrona un flow specifico in base al suo nome (che è univoco all'interno del tenant). L'unico argomento di questo metodo è il nome del flow.

Il tipo di ritorno è una lista di tipo IpaasFlow.

CreateFlowAsync​

Questo metodo è utilizzato per creare un nuovo flow. L'argomento da passare è un oggetto di tipo IpaasFlow che contiene tutta la definizione del flow, compresa la destination.

Il tipo di ritorno è un oggetto di tipo IpaasFlow.

UpdateFlowAsync​

Questo metodo è utilizzato per aggiornare un flow esistente.

Il tipo di ritorno è un oggetto di tipo IpaasFlow.

ReloadFlowAsync​

Questo metodo è utilizzato per ricaricare un flow esistente.

Questo metodo non ha tipo di ritorno.

Destination​

GetAllDestinationsAsync​

Questo metodo è utilizzato per recuperare in maniera asincrona tutte le destination presenti nel tenant.

Fra i parametri opzionali, è possibile specificare un filtro per recuperare solo le destination che soddisfano determinate condizioni.

La struttura dell'oggetto da utilizzare per recuperare tutte le destination con un determinato name è la seguente:

{
    "requestAll": true,
    "filter": [
        {
            "name": "name", // id, name
            "comparator": "equal", // equal, notEqual, contains, notContains
            "value": "destinationName", // the actual value to compare
            "caseSensitive": false, // true, false
            "operator": "and" // and, or
        }
    ]
}

Il tipo di ritorno è una lista di tipo IpaasDestination.

GetDestinationByNameAsync​

Questo metodo è utilizzato per recuperare in maniera asincrona una destination specifica in base al suo nome (che è univoco all'interno del tenant). L'unico argomento di questo metodo è il nome del flow.

Il tipo di ritorno è un oggetto di tipo IpaasFlow.

CreateDestinationAsync​

Questo metodo è utilizzato per creare una nuova destination.

Il tipo di ritorno è un oggetto di tipo IpaasDestination.

UpdateDestinationAsync​

Questo metodo è utilizzato per aggiornare una destination esistente.

Il tipo di ritorno è un oggetto di tipo IpaasDestination.