Passa al contenuto principale

Riferimento API

Benvenuto nella documentazione API di Flowlyze. Questa pagina introduttiva riassume le modalità di autenticazione e i requisiti comuni richiesti dalle API.

Tag API disponibili​

Le API sono organizzate nei seguenti tag:

  • Batch - Operazioni di elaborazione batch
  • BatchTask - Gestione delle attività batch
  • BlockedTopic - Operazioni sui topic bloccati
  • Dashboard - Endpoint relativi alla dashboard
  • DataSpace - Gestione dei dataspaces
  • Destination - Configurazione delle destinazioni
  • EditableFlow - Modifica e gestione dei flow
  • Flow - Gestione dei flow
  • GlobalVariable - Gestione delle variabili globali
  • IngressIncrementalField - Operazioni su campi incrementali
  • Logs - Logging e monitoraggio
  • LowCodeAction - Operazioni su azioni low-code
  • MessageInfo - Informazioni sui messaggi
  • MessageQueue - Operazioni sulle code di messaggi
  • Metadata - Gestione dei metadati
  • Platform - Operazioni sulle piattaforme
  • PlatformGlobal - Impostazioni globali delle piattaforme
  • PlatformTenantGlobal - Impostazioni specifiche per tenant
  • Queue - Gestione delle code
  • SecretGlobalVariable - Gestione delle variabili segrete
  • Statistic - Statistiche e analisi
  • Tenant - Gestione dei tenant
  • Test - Endpoint di test
  • UserSettings - Gestione impostazioni utente
  • Version - Informazioni di versione

Autenticazione (OAuth 2.0 – client_credentials)​

Le API di Flowlyze utilizzano OAuth 2.0 con grant type client_credentials.

  • Identity Provider: Auth0
  • Base URL Auth0: https://secure-oauth-prd.eu.auth0.com/
  • Token endpoint (convenzione Auth0): POST https://secure-oauth-prd.eu.auth0.com/oauth/token

Richiesta token (esempio):

curl -X POST \
  https://secure-oauth-prd.eu.auth0.com/oauth/token \
  -H "content-type: application/json" \
  -d '{
    "grant_type": "client_credentials",
    "client_id": "<CLIENT_ID>",
    "client_secret": "<CLIENT_SECRET>",
    "audience": "<API_AUDIENCE>"
  }'

Risposta tipica:

{
  "access_token": "eyJhbGciOi...",
  "token_type": "Bearer",
  "expires_in": 86400
}

Uso del token nelle chiamate API:

Authorization: Bearer <ACCESS_TOKEN>

Header multi-tenant richiesto​

Le API sono multi-tenant. È necessario specificare il tenant di lavoro tramite l'header:

tenant_id: <ID_TENANT>

Questo header deve essere incluso in tutte le richieste verso le API.

Contenuti della documentazione​

Per ciascun tag API troverai:

  • Elenco endpoint disponibili
  • Schemi di richiesta/risposta
  • Requisiti di autenticazione
  • Esempi di richieste e risposte

Utilizza la sidebar per navigare tra le categorie API.