Zistenie nastavení webhooku (vlastných nastavení operátora, alebo s administrátorským kľúčom klienta nastavení tohto klienta)
- V sandboxe
Jednoducho povedané
Od 0.16.0 kľúč operátora číta nastavenia jedného klienta cez client. Administrátorský kľúč klienta môže uviesť len
vlastného klienta; každý iný odpovie 404. Neznámy alebo opakovaný parameter, alebo prázdny client, odpovie 400.
Nastavenie a testovanie webhooku neberú žiadne parametre dotazu (400): zostávajú pri vlastnom kľúči webhooku.
apiKeyAuthorizationBearer <token>Kľúč posielajte ako token typu Bearer: Authorization: Bearer <your-api-key>. Stav služby je jediné volanie, ktoré nevyžaduje kľúč.
client?stringVoľba klienta zo strany operátora. Iný tvar odpovie 400.
^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$Aktuálne nastavenia. Tajný kľúč sa nikdy nevracia. Ak nie je nič nastavené, url je null a active je false.
application/json- response
url*|^https://uriactive*booleansecret_rotated_at?|date-timecontact_email?|Koho informovať, keď doručenia zlyhávajú.
last_delivery?|nullcurl -X GET "https://example.com/webhook" \ -H "Authorization: Bearer <your-api-key>"{ "url": "http://example.com", "active": true, "secret_rotated_at": "2019-08-24T14:15:22Z", "contact_email": "string", "last_delivery": { "at": "2019-08-24T14:15:22Z", "http_status": 0 }}Zostavenie a kontrola dokumentu bez odoslania POST
Spustí schému, predbežné kontroly, serializátor pre kanál a každú oficiálnu validačnú vrstvu, potom vráti protokol a dokumenty, ktoré zostavil, každý s bajtmi v content_base64, ak má 2 MiB alebo menej. Nič sa neodošle a nič sa neuloží okrem záznamu požiadavky. Použite ho pri mapovaní nového klienta. Číslo mimo limitov (pozri konvencie) odpovie 422 ešte pred spustením akejkoľvek kontroly.
Nastavenie URL webhooku alebo výmena jeho tajného kľúča PUT
Kľúč operátora nastavuje webhook operátora, ktorý dostáva udalosti všetkých klientov; administrátorský kľúč klienta nastavuje webhook tohto klienta, ktorý dostáva len jeho udalosti. Prvé volanie potrebuje url a vytvorí tajný kľúč, ktorý sa vráti raz. Výmena vráti nový tajný kľúč raz. Po 24 hodín služba podpisuje každé doručenie novým aj starým tajným kľúčom, aby mohol partner prepnúť bez straty udalostí. Doručujú sa len udalosti zapísané po prvom volaní. URL musí byť https a každá adresa, na ktorú sa jeho hostiteľ preloží, musí byť verejná: loopback, privátne adresy, link-local, carrier-grade NAT, multicast, rezervované a metadátové adresy cloudu sa odmietajú, tu aj znova pred každým doručením. Presmerovania sa nesledujú. Od 0.16.0 každý parameter dotazu odpovie 400, takže chybne napísaný client nikdy nemôže zmeniť webhook operátora.