Tutorial: Creazione di un endpoint webhook utilizzando un URL della funzione Lambda - AWS Lambda

Tutorial: Creazione di un endpoint webhook utilizzando un URL della funzione Lambda

In questo tutorial creerai un URL della funzione Lambda per implementare un endpoint webhook. Un webhook è una comunicazione leggera basata sugli eventi che invia automaticamente i dati tra le applicazioni tramite HTTP. È possibile utilizzare un webhook per ricevere aggiornamenti immediati sugli eventi che si verificano in un altro sistema, ad esempio quando un nuovo cliente si registra su un sito Web, viene elaborato un pagamento o viene caricato un file.

Con Lambda, i webhook possono essere implementati utilizzando gli URL delle funzioni Lambda o l'API Gateway. Gli URL delle funzioni sono un'ottima scelta per webhook semplici che non richiedono funzionalità come l'autorizzazione avanzata o la convalida delle richieste.

Suggerimento

Se non sei certo di quale soluzione sia la migliore per il tuo caso d'uso particolare, consultaSelezionare un metodo per richiamare la funzione Lambda tramite una richiesta HTTP.

Prerequisiti

Per completare questo tutorial, devi avere Python (versione 3.8 o successiva) o Node.js (versione 18 o successiva) installato sul tuo computer locale.

Per testare l'endpoint utilizzando una richiesta HTTP, il tutorial utilizza curl, uno strumento a riga di comando che è possibile utilizzare per trasferire dati utilizzando vari protocolli di rete. Fai riferimento alla documentazione di curl per scoprire come installare lo strumento se non lo possiedi già.

Creazione della funzione Lambda

Per prima cosa crea la funzione Lambda che viene eseguita quando una richiesta HTTP viene inviata al tuo endpoint webhook. In questo esempio, l'applicazione di invio invia un aggiornamento ogni volta che viene inviato un pagamento e indica nel corpo della richiesta HTTP se il pagamento è andato a buon fine. La funzione Lambda analizza la richiesta e interviene in base allo stato del pagamento. In questo esempio, il codice stampa solo l'ID dell'ordine per il pagamento, ma in un'applicazione reale è possibile aggiungere l'ordine a un database o inviare una notifica.

La funzione implementa anche il metodo di autenticazione più comune utilizzato per i webhook, l'autenticazione dei messaggi basata su hash (HMAC). Con questo metodo, sia l'applicazione di invio che quella di ricezione condividono una chiave segreta. L'applicazione di invio utilizza un algoritmo di hashing per generare una firma univoca utilizzando questa chiave insieme al contenuto del messaggio e include la firma nella richiesta del webhook come intestazione HTTP. L'applicazione ricevente ripete quindi questo passaggio, generando la firma utilizzando la chiave segreta e confronta il valore risultante con la firma inviata nell'intestazione della richiesta. Se il risultato corrisponde, la richiesta viene considerata legittima.

Crea la funzione utilizzando la console Lambda con il runtime Python o Node.js.

Python
Creazione della funzione Lambda
  1. Aprire la pagina Funzioni della console Lambda.

  2. Crea una funzione di base «Hello world» utilizzando le operazioni seguenti:

    1. Scegli Crea funzione.

    2. Scegli Crea da zero.

    3. Nel campo Function name (Nome funzione), immettere myLambdaWebhook.

    4. In Runtime, scegli Python 3.11.

    5. Scegli Crea funzione.

  3. Nel riquadro Codice sorgente, sostituisci il codice esistente copiando e incollando quanto segue:

    import json import hmac import hashlib import os def lambda_handler(event, context): # Get the webhook secret from environment variables webhook_secret = os.environ['WEBHOOK_SECRET'] # Verify the webhook signature if not verify_signature(event, webhook_secret): return { 'statusCode': 401, 'body': json.dumps({'error': 'Invalid signature'}) } try: # Parse the webhook payload payload = json.loads(event['body']) # Handle different event types event_type = payload.get('type') if event_type == 'payment.success': # Handle successful payment order_id = payload.get('orderId') print(f"Processing successful payment for order {order_id}") # Add your business logic here # For example, update database, send notifications, etc. elif event_type == 'payment.failed': # Handle failed payment order_id = payload.get('orderId') print(f"Processing failed payment for order {order_id}") # Add your business logic here else: print(f"Received unhandled event type: {event_type}") # Return success response return { 'statusCode': 200, 'body': json.dumps({'received': True}) } except json.JSONDecodeError: return { 'statusCode': 400, 'body': json.dumps({'error': 'Invalid JSON payload'}) } except Exception as e: print(f"Error processing webhook: {e}") return { 'statusCode': 500, 'body': json.dumps({'error': 'Internal server error'}) } def verify_signature(event, webhook_secret): """ Verify the webhook signature using HMAC """ try: # Get the signature from headers signature = event['headers'].get('x-webhook-signature') if not signature: print("Error: Missing webhook signature in headers") return False # Get the raw body (return an empty string if the body key doesn't exist) body = event.get('body', '') # Create HMAC using the secret key expected_signature = hmac.new( webhook_secret.encode('utf-8'), body.encode('utf-8'), hashlib.sha256 ).hexdigest() # Compare the expected signature with the received signature to authenticate the message is_valid = hmac.compare_digest(signature, expected_signature) if not is_valid: print(f"Error: Invalid signature. Received: {signature}, Expected: {expected_signature}") return False return True except Exception as e: print(f"Error verifying signature: {e}") return False
  4. Nella sezione DEPLOY, scegli Implementa per aggiornare il codice della tua funzione.

Node.js
Creazione della funzione Lambda
  1. Aprire la pagina Funzioni della console Lambda.

  2. Crea una funzione di base «Hello world» utilizzando le operazioni seguenti:

    1. Scegli Crea funzione.

    2. Scegli Crea da zero.

    3. Nel campo Function name (Nome funzione), immettere myLambdaWebhook.

    4. Per Runtime (Runtime), selezionare Node.js 6.10.

    5. Scegli Crea funzione.

  3. Nel riquadro Codice sorgente, sostituisci il codice esistente copiando e incollando quanto segue:

    import crypto from 'crypto'; export const handler = async (event, context) => { // Get the webhook secret from environment variables const webhookSecret = process.env.WEBHOOK_SECRET; // Verify the webhook signature if (!verifySignature(event, webhookSecret)) { return { statusCode: 401, body: JSON.stringify({ error: 'Invalid signature' }) }; } try { // Parse the webhook payload const payload = JSON.parse(event.body); // Handle different event types const eventType = payload.type; switch (eventType) { case 'payment.success': { // Handle successful payment const orderId = payload.orderId; console.log(`Processing successful payment for order ${orderId}`); // Add your business logic here // For example, update database, send notifications, etc. break; } case 'payment.failed': { // Handle failed payment const orderId = payload.orderId; console.log(`Processing failed payment for order ${orderId}`); // Add your business logic here break; } default: console.log(`Received unhandled event type: ${eventType}`); } // Return success response return { statusCode: 200, body: JSON.stringify({ received: true }) }; } catch (error) { if (error instanceof SyntaxError) { // Handle JSON parsing errors return { statusCode: 400, body: JSON.stringify({ error: 'Invalid JSON payload' }) }; } // Handle all other errors console.error('Error processing webhook:', error); return { statusCode: 500, body: JSON.stringify({ error: 'Internal server error' }) }; } }; // Verify the webhook signature using HMAC const verifySignature = (event, webhookSecret) => { try { // Get the signature from headers const signature = event.headers['x-webhook-signature']; if (!signature) { console.log('No signature found in headers:', event.headers); return false; } // Get the raw body (return an empty string if the body key doesn't exist) const body = event.body || ''; // Create HMAC using the secret key const hmac = crypto.createHmac('sha256', webhookSecret); const expectedSignature = hmac.update(body).digest('hex'); // Compare expected and received signatures const isValid = signature === expectedSignature; if (!isValid) { console.log(`Invalid signature. Received: ${signature}, Expected: ${expectedSignature}`); return false; } return true; } catch (error) { console.error('Error during signature verification:', error); return false; } };
  4. Nella sezione DEPLOY, scegli Implementa per aggiornare il codice della tua funzione.

Creazione del segreto di

Per autenticare la richiesta webhook, la funzione Lambda utilizza una chiave segreta che condivide con l'applicazione chiamante. In questo esempio, la variabile di ambiente è impostata su . In un'applicazione di produzione, non includere informazioni sensibili come le password nel codice funzione. Invece, crea un Gestione dei segreti AWS segreto e poi usa l'estensione Lambda AWS Parameters and Secrets per recuperare le credenziali nella funzione Lambda.

Crea e archivia la chiave segreta del webhook
  1. Genera una stringa lunga e casuale utilizzando un generatore di numeri casuali crittograficamente sicuro. Puoi usare i seguenti frammenti di codice in Python o Node.js per generare e stampare un segreto di 32 caratteri o usare il tuo metodo preferito.

    Python
    Esempio codice per generare un segreto
    import secrets webhook_secret = secrets.token_urlsafe(32) print(webhook_secret)
    Node.js
    Esempio codice per generare un segreto (formato del modulo ES)
    import crypto from 'crypto'; let webhookSecret = crypto.randomBytes(32).toString('base64'); console.log(webhookSecret)
  2. Memorizza la stringa generata come variabile di ambiente per la funzione utilizzando le operazioni seguenti:

    1. Nella sezione Variabili di ambiente della pagina di configurazione per la funzione, scegli Modifica.

    2. Scegli Modifica.

    3. Scegli Add environment variable (Aggiungi variabile d'ambiente).

    4. Per ChiaveWEBHOOK_SECRET, inserisci, quindi per Valore, inserisci il segreto generato nel passaggio precedente.

    5. Selezionare Salva.

Sarà necessario utilizzare nuovamente questo segreto più avanti nel tutorial per testare la funzione, quindi prendine nota ora.

Verifica l'endpoint URL della funzione

Crea un endpoint per il tuo webhook utilizzando l'URL di una funzione Lambda. Poiché utilizzi il tipo di autenticazione di NONE per creare un endpoint con accesso pubblico, chiunque disponga dell'URL può richiamare la tua funzione. Per ulteriori informazioni sul controllo dell'accesso agli URL delle funzioni, consulta. Controllo dell'accesso agli URL della funzione Lambda Se hai bisogno di opzioni di autenticazione più avanzate per il tuo webhook, prendi in considerazione l'utilizzo di API Gateway.

Verifica l'endpoint URL della funzione
  1. Seleziona la scheda Configurazione per la tua funzione.

  2. Scegli Crea URL della funzione.

  3. Per il tipo di autenticazione, seleziona NESSUNA.

  4. Selezionare Salva.

L'endpoint per l'URL della funzione appena creato viene visualizzato nel riquadro URL della funzione. Copiare l'endpoint per utilizzarlo più avanti nel tutorial.

Testare la funzione tramite la console .

Prima di utilizzare una richiesta HTTP per richiamare la funzione utilizzando l'endpoint URL, testala nella console per confermare che il codice funzioni come previsto.

Per verificare la funzione nella console, devi prima calcolare una firma webhook utilizzando il segreto generato in precedenza nel tutorial con il seguente payload JSON di test:

{ "type": "payment.success", "orderId": "1234", "amount": "99.99" }

Usa uno dei seguenti esempi di codice Python o Node.js per calcolare la firma del webhook usando il tuo segreto.

Python
Calcolare la firma del webhook
  1. Salva il seguente codice in un file denominato calculate_signature.py. Sostituisci il codice segreto del webhook con il tuo valore.

    import secrets import hmac import json import hashlib webhook_secret = "arlbSDCP86n_1H90s0fL_Qb2NAHBIBQOyGI0X4Zay4M" body = json.dumps({"type": "payment.success", "orderId": "1234", "amount": "99.99"}) signature = hmac.new( webhook_secret.encode('utf-8'), body.encode('utf-8'), hashlib.sha256 ).hexdigest() print(signature)
  2. Calcolare la firma utilizzando il comando seguente dalla stessa directory in cui hai salvato il codice. Copia la firma generata dal codice.

    python calculate_signature.py
Node.js
Calcolare la firma del webhook
  1. Salva il seguente codice in un file denominato calculate_signature.mjs. Sostituisci il codice segreto del webhook con il tuo valore.

    import crypto from 'crypto'; const webhookSecret = "arlbSDCP86n_1H90s0fL_Qb2NAHBIBQOyGI0X4Zay4M" const body = "{\"type\": \"payment.success\", \"orderId\": \"1234\", \"amount\": \"99.99\"}"; let hmac = crypto.createHmac('sha256', webhookSecret); let signature = hmac.update(body).digest('hex'); console.log(signature);
  2. Calcolare la firma utilizzando il comando seguente dalla stessa directory in cui hai salvato il codice. Copia la firma generata dal codice.

    node calculate_signature.mjs

Ora puoi testare il codice della funzione utilizzando una richiesta HTTP di prova nella console.

Testare la funzione tramite la console .
  1. Seleziona la scheda Codice per la tua funzione.

  2. Nella sezione Evento di Prova , scegliere Nuovo evento.

  3. Per Event name (Nome evento), immettere myEvent.

  4. Sostituisci il codice JSON esistente copiando e incollando quanto segue nel riquadro Event JSON. Sostituisci la firma del webhook con il valore calcolato nel passaggio precedente.

    { "headers": { "Content-Type": "application/json", "x-webhook-signature": "2d672e7a0423fab740fbc040e801d1241f2df32d2ffd8989617a599486553e2a" }, "body": "{\"type\": \"payment.success\", \"orderId\": \"1234\", \"amount\": \"99.99\"}" }
  5. Selezionare Salva.

  6. Scegliere Invoke (Invoca).

    Verrà visualizzato un output simile al seguente:

    Python
    Status: Succeeded Test Event Name: myEvent Response: { "statusCode": 200, "body": "{\"received\": true}" } Function Logs: START RequestId: 50cc0788-d70e-453a-9a22-ceaa210e8ac6 Version: $LATEST Processing successful payment for order 1234 END RequestId: 50cc0788-d70e-453a-9a22-ceaa210e8ac6 REPORT RequestId: 50cc0788-d70e-453a-9a22-ceaa210e8ac6 Duration: 1.55 ms Billed Duration: 2 ms Memory Size: 128 MB Max Memory Used: 36 MB Init Duration: 136.32 ms
    Node.js
    Status: Succeeded Test Event Name: myEvent Response: { "statusCode": 200, "body": "{\"received\":true}" } Function Logs: START RequestId: e54fe6c7-1df9-4f05-a4c4-0f71cacd64f4 Version: $LATEST 2025-01-10T18:05:42.062Z e54fe6c7-1df9-4f05-a4c4-0f71cacd64f4 INFO Processing successful payment for order 1234 END RequestId: e54fe6c7-1df9-4f05-a4c4-0f71cacd64f4 REPORT RequestId: e54fe6c7-1df9-4f05-a4c4-0f71cacd64f4 Duration: 60.10 ms Billed Duration: 61 ms Memory Size: 128 MB Max Memory Used: 72 MB Init Duration: 174.46 ms Request ID: e54fe6c7-1df9-4f05-a4c4-0f71cacd64f4

Esegui il test della funzione tramite una richiesta HTTP

Usa lo strumento da riga di comando curl per testare il tuo endpoint webhook.

Esegui il test della funzione tramite le richieste HTTP
  1. In un terminale o in un programma shell, esegui il seguente comando curl. Sostituisci l'URL con il valore dell'endpoint URL della tua funzione e sostituisci la firma del webhook con la firma calcolata utilizzando la tua chiave segreta.

    curl -X POST https://ryqgmbx5xjzxahif6frvzikpre0bpvpf.lambda-url.us-west-2.on.aws/ \ -H "Content-Type: application/json" \ -H "x-webhook-signature: d5f52b76ffba65ff60ea73da67bdf1fc5825d4db56b5d3ffa0b64b7cb85ef48b" \ -d '{"type": "payment.success", "orderId": "1234", "amount": "99.99"}'

    Verrà visualizzato l'output seguente:

    {"received": true}
  2. Ispeziona i log di CloudWatch per verificare che la funzione abbia analizzato correttamente il payload effettuando le seguenti operazioni:

    1. Nella console Amazon CloudWatch, apri la pagina Log Groups (Gruppi di log).

    2. Scegli il gruppo di log della funzione (/aws/lambda/myLambdaWebhook).

    3. Seleziona il flusso di log più recente.

      Verrà visualizzato un output simile al seguente:

      Python
      Processing successful payment for order 1234
      Node.js
      2025-01-10T18:05:42.062Z e54fe6c7-1df9-4f05-a4c4-0f71cacd64f4 INFO Processing successful payment for order 1234
  3. Verifica che il codice rilevi una firma non valida eseguendo il seguente comando curl. Sostituisci l'URL con il tuo endpoint URL della funzione.

    curl -X POST https://ryqgmbx5xjzxahif6frvzikpre0bpvpf.lambda-url.us-west-2.on.aws/ \ -H "Content-Type: application/json" \ -H "x-webhook-signature: abcdefg" \ -d '{"type": "payment.success", "orderId": "1234", "amount": "99.99"}'

    Verrà visualizzato l'output seguente:

    {"error": "Invalid signature"}

Pulizia delle risorse

Ora è possibile eliminare le risorse create per questo tutorial, a meno che non si voglia conservarle. Eliminando le risorse AWS che non si utilizzano più, è possibile evitare addebiti superflui sul proprio account Account AWS.

Per eliminare la funzione Lambda
  1. Aprire la pagina Functions (Funzioni) della console Lambda.

  2. Selezionare la funzione creata.

  3. Scegliere Operazioni, Elimina.

  4. Inserisci confirm nel campo di immissione del testo, quindi scegli Elimina.

Quando hai creato la funzione Lambda nella console, Lambda ha anche creato un ruolo di esecuzione per la tua funzione.

Come eliminare il ruolo di esecuzione
  1. Aprire la pagina Ruoli della console IAM.

  2. Selezionare il ruolo di esecuzione creato. Il formato del nome è myLambdaWebhook-role-<random string>.

  3. Scegliere Elimina.

  4. Inserisci il nome del ruolo nel campo di immissione testo e seleziona Elimina.