Tapaya
PanoramicaWebhookConfigurazione

Configurazione

Configuri la destinazione e le iscrizioni dell'organizzazione tramite Platform o API.

Ogni organizzazione dispone di una destinazione webhook e di un signing secret (chiave di firma) attivo. Lo configuri nella Platform o dal Suo server.

DettaglioValore
URL di basehttps://api.sandbox.tapaya.com per la sandbox, https://api.tapaya.com per la produzione
AutenticazioneServer Secret Token in Authorization. Si veda Autenticazione.
AmbitoUna destinazione per organizzazione
Guida correlataVerificare e testare

Configurare nella Platform

Apra API Keys per la Sua organizzazione e individui Webhooks.

  1. Inserisca il Suo URL HTTPS pubblico.
  2. Scelga gli eventi di cui ha bisogno oppure attivi Subscribe to all webhook types.
  3. Attivi Enable e faccia clic su Save.
  4. Copi il signing secret e lo conservi sul Suo server.
  5. Invii un webhook di test.

Il signing secret viene mostrato una sola volta

Lo copi quando crea o ruota la destinazione; non potrà recuperarlo in seguito. Serve solo a verificare i webhook in arrivo. Il Server Secret Token autorizza le richieste di configurazione.

Tutte le operazioni

OperazioneServe a
Salvare una destinazioneCreare o sostituire l'iscrizione corrente oppure ruotarne il signing secret.
Leggere una destinazioneRecuperare l'URL corrente, la modalità di iscrizione e lo stato di abilitazione.
Eliminare una destinazioneRimuovere l'iscrizione, la coda di consegna e la cronologia.

Gestire la destinazione

Regole della destinazione

Modificare le impostazioni

QuandoCosa succede
Modifica l'URL, gli eventi o il segretoI nuovi eventi usano le nuove impostazioni. Gli eventi in coda mantengono l'URL e il segreto precedenti, quindi li mantenga entrambi funzionanti finché la coda non si svuota.
Disabilita i webhookLe consegne in coda vengono sospese e non vengono acquisiti nuovi eventi. La riabilitazione riprende la coda, ma le modifiche perse non vengono recuperate retroattivamente. I test funzionano comunque.
Elimina la destinazioneGli eventi in coda e la cronologia delle consegne vengono rimossi. Una richiesta già in corso può comunque arrivare. Ricreare la destinazione genera un nuovo signing secret.

Requisiti dell'URL

  • HTTPS pubblico sulla porta 443. Localhost e reti private vengono rifiutati, e il DNS viene controllato nuovamente a ogni connessione.
  • Nessuna credenziale incorporata, nessun frammento e nessun reindirizzamento.
  • Nessun header di autorizzazione personalizzato. Verifichi invece la firma Tapaya, oppure inserisca un adattatore lato server davanti a un URL che richiede una propria chiave.

Errori

Le richieste di configurazione falliscono con queste risposte. Un ricevitore che rifiuta o non riceve una consegna è un problema diverso; si veda Gestire gli errori.

RispostaSignificato
400 su PUTURL non valido, tipo di evento non supportato, campo obbligatorio mancante oppure selezione esplicita degli eventi vuota.
401Il Server Secret Token è mancante o non valido.
404 su GETNon esiste una destinazione per l'organizzazione autenticata.

Prosegua con la verifica della firma e la consegna di test.

Manca qualcosa in questa pagina?Richieda una funzionalità. Alleghiamo questa pagina, così il team vede il contesto.