Pobranie ustawień webhooka (operatora albo, z kluczem administratora klienta, tego klienta)
- W sandboxie
Prostymi słowami
Od 0.16.0 klucz operatora odczytuje ustawienia jednego klienta po podaniu client. Klucz administratora klienta może podać tylko
własnego klienta; każdy inny daje odpowiedź 404. Nieznany lub powtórzony parametr albo puste client daje odpowiedź 400.
Ustawianie i testowanie webhooka nie przyjmują żadnych parametrów zapytania (400): pozostają przy kluczu samego webhooka.
apiKeyAuthorizationBearer <token>Klucz należy wysyłać jako token typu bearer: Authorization: Bearer <your-api-key>. Wywołanie stanu usługi jest jedynym, które nie wymaga klucza.
client?stringWybór klienta przez operatora. Inny kształt daje odpowiedź 400.
^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$Bieżące ustawienia. Sekret nigdy nie jest zwracany. Gdy nic nie ustawiono, url ma wartość null, a active false.
application/json- response
url*|^https://uriactive*booleansecret_rotated_at?|date-timecontact_email?|Kogo powiadomić, gdy dostarczanie przestaje działać.
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 }}Zbudowanie i sprawdzenie dokumentu bez jego wysyłania POST
Uruchamia schemat, kontrole wstępne, serializator dla kanału i każdą oficjalną warstwę walidacji, po czym zwraca raport i zbudowane dokumenty, każdy z bajtami w content_base64, jeśli ma 2 MiB lub mniej. Nic nie jest wysyłane i nic nie jest przechowywane poza dziennikiem żądań. Przydaje się przy mapowaniu nowego klienta. Liczba poza limitami (patrz konwencje) daje odpowiedź 422 przed jakąkolwiek kontrolą.
Ustawienie adresu URL webhooka albo rotacja jego sekretu PUT
Klucz operatora ustawia webhook operatora, który dostaje zdarzenia wszystkich klientów; klucz administratora klienta ustawia webhook tego klienta, który dostaje tylko jego zdarzenia. Pierwsze wywołanie wymaga url i tworzy sekret, który jest zwracany raz. Rotacja zwraca nowy sekret raz. Przez 24 godziny usługa podpisuje każde dostarczenie zarówno nowym, jak i starym sekretem, aby partner mógł przełączyć się bez utraty zdarzeń. Dostarczane są tylko zdarzenia zapisane po pierwszym wywołaniu. Adres URL musi być https, a każdy adres, na który rozwiązuje się jego host, musi być publiczny: adresy pętli zwrotnej, prywatne, link-local, carrier-grade NAT, multicast, zarezerwowane i metadanych chmury są odrzucane, tu i ponownie przed każdym dostarczeniem. Przekierowania nie są wykonywane. Od 0.16.0 każdy parametr zapytania daje odpowiedź 400, więc błędnie napisane client nigdy nie zmieni własnego webhooka operatora.