Http Message Queue
Destinazione passiva per richiedere i messaggi a Flowlyze, i messaggi rimangono in stato "New" fino a quando non sono richiesti.
Settings
Path: Parte finale dell'endpoint per la richiesta dei messaggi
ApiKey: Chiave da inserire nella richiesta per l'autenticazione
N.B.: I settings non possono essere sovrascritti nel Flow.
Endpoints
Gli endpoint completi sono disponibili sulla Destination all'interno di Flowlyze.
Queue
Campo | Valore | Descrizione |
---|---|---|
Method | GET | Metodo HTTP utilizzato per effettuare la richiesta. |
Resource Path | /api/message-queue/{tenant_id}/{path} | Percorso dell'endpoint per richiedere i messaggi dalla coda. |
Query Params | is-acknowledged (bool ) | Indica se sul messaggio deve essere effettuata la chiamata di acknowledge. Valore predefinito: false . |
Query Params | max-items (int ) | Numero massimo di messaggi restituiti. Valore predefinito: 10 . |
Headers | x-apikey (string ) | Chiave API definita nella configurazione della destinazione. |
Note aggiuntive:
tenant_id
epath
sono parametri dinamici che devono essere sostituiti con i valori specifici del tenant e del percorso desiderato.- È consigliabile verificare la validità della chiave API (
x-apikey
) prima di effettuare la richiesta.
Acknowledge
Campo | Valore | Descrizione |
---|---|---|
Method | POST | Metodo HTTP utilizzato per effettuare la richiesta. |
Resource Path | /api/message-queue/{tenant_id}/{path}/acknowledge | Endpoint per eseguire l'acknowledge sui messaggi. |
Headers | x-apikey (string ) | Chiave API definita nella configurazione della destinazione. |
Body | JSON | Corpo della richiesta. Vedi struttura dettagliata del body qui sotto. |
Struttura del Body
{
"isAsync": false, // Se true, esegue l'aggiornamento in modo asincrono
"messages": [
{
"msgId": "6785469c8046471646714630", // ID univoco del messaggio
"status": "Success", // Stato del messaggio: "Success" o "Error"
"errorMessage": "" // Messaggio di errore, presente solo in caso di "Error"
}
]
}