Tapaya
PřehledWebhookyNastavení

Nastavení

Nastavte cílovou adresu a odběr událostí organizace přes Platform nebo API.

Každá organizace má jednu cílovou adresu webhooku a jeden aktivní signing secret (podpisový klíč). Nastavte je v Platform nebo ze serveru.

ÚdajHodnota
Základní URLhttps://api.sandbox.tapaya.com pro sandbox, https://api.tapaya.com pro produkci
AutentizaceServer Secret Token v hlavičce Authorization. Viz Autentizace.
RozsahJedna cílová adresa na organizaci
Související průvodceOvěření a testování

Nastavení v Platform

Otevřete API Keys pro svou organizaci a najděte Webhooks.

  1. Zadejte veřejnou HTTPS adresu.
  2. Vyberte potřebné události nebo zapněte Subscribe to all webhook types.
  3. Zapněte Enable a klikněte na Save.
  4. Zkopírujte podpisový klíč a uložte ho na server.
  5. Odešlete testovací webhook.

Podpisový klíč se zobrazí jen jednou

Zkopírujte ho při vytvoření nebo obměně cílové adresy; později ho již nelze načíst. Slouží pouze k ověření příchozích webhooků. Požadavky na nastavení autorizuje váš Server Secret Token.

Všechny operace

OperaceK čemu slouží
Uložení cílové adresyVytvořit nebo nahradit aktuální odběr či obměnit podpisový klíč.
Načtení cílové adresyZískat aktuální URL, režim odběru a stav povolení.
Smazání cílové adresyOdstranit odběr, frontu doručování i historii.

Správa cílové adresy

Pravidla cílové adresy

Změna nastavení

KdyžCo se stane
Změníte URL, události nebo klíčNové události použijí nové nastavení. Události ve frontě si ponechají starou URL i klíč, proto udržujte obojí funkční, dokud se fronta nevyprázdní.
Vypnete webhookyDoručování z fronty se pozastaví a nové události se nezachycují. Opětovné zapnutí obnoví frontu, ale zmeškané změny se zpětně nedoplní. Testy fungují i nadále.
Smažete cílovou adresuUdálosti ve frontě i historie doručování se odstraní. Již odesílaný požadavek může stále dorazit. Opětovné vytvoření vytvoří nový podpisový klíč.

Požadavky na URL

  • Veřejné HTTPS na portu 443. Localhost a privátní sítě se odmítají a DNS se znovu ověřuje při každém připojení.
  • Žádné vložené přihlašovací údaje, žádný fragment a žádná přesměrování.
  • Žádné vlastní autorizační hlavičky. Místo toho ověřujte podpis Tapaya, nebo před URL, která vyžaduje vlastní klíč, umístěte serverový adaptér.

Chyby

Požadavky na nastavení selhávají s těmito odpověďmi. Příjemce, který doručení odmítne nebo ho nepřijme, je jiný problém; viz Řešení chyb.

OdpověďVýznam
400 při PUTNeplatná URL, nepodporovaný typ události, chybějící povinné pole nebo prázdný výslovný výběr událostí.
401Server Secret Token chybí nebo je neplatný.
404 při GETPro autentizovanou organizaci neexistuje cílová adresa.

Pokračujte na ověření podpisu a test doručení.

Chybí vám něco na této stránce?Navrhněte funkci. Připojíme tuto stránku, aby tým viděl souvislosti.