Integracja klientów Fakturowni za pomocą webhooków

Utworzono: 2015-07-15
Ostatnia aktualizacja: 2019-08-26
Liczba odwiedzin posta: 2441

Webhooki to - obok interfejsu programistycznego API - mechanizm pozwalający na komunikację pomiędzy serwerami. Przeznaczony jest głównie dla deweloperów i zaawansowanych Użytkowników.

Zastosowanie webhooków zmniejsza obciążenie serwera aplikacji, ponieważ potrzebne informacje są automatycznie wysyłane w chwili, kiedy wystąpi określone zdarzenie, więc nie trzeba odpytywać intefejsu API, czy zaszły jakiekolwiek zmiany. Powiadomienia o zdarzeniach są otrzymywane dokładnie w momencie ich zaistnienia, bez konieczności zbyt częstego odpytywania aplikacji.

Webhook posiada:

  • typ, który określa, kiedy webhook ma zostać wysłany (po stworzeniu/zaktualizowaniu/usunięciu klienta)

  • URL, czyli adres URL, pod który wysyłany jest webhook

  • API token, czyli token uwierzytelniający, który użytkownik może dodać do webhooka i który będzie widoczny pod kluczem 'api_token'

Webhook to POST wysyłany na wskazany URL o następującej strukturze:

{
client_id: <unikalne ID reprezentujące klienta w bazie Fakturowni>,
client: { <słownik reprezentujący klienta w Fakturowni> },
app_name: 'fakturownia',
api_token: <api_token wpisany w webhooku przez uzytkownika>,
locale: I18n.locale (np. 'pl')
}

 



Powrót


Komentarze

Avatar sugester medium
wmajchrzak
Dzień dobry.

Czy po wywołaniu Requestu fakturownia oczekuje jakiejś konkretnej odpowiedzi np. Header 200 OK? Zastanawiam się co w przypadku gdy na naszym serwerze pojawi się np. błąd lub zabraknie komunikacji. Czy fakturownia będzie ponawiać ten request do czasu aż dostanie prawidłową odpowiedź?

2019-06-28 09:36

Zgłoś naruszenie zasad

piotr.wajs
piotr.wajs
Odpowiedź główna   Dzień dobry,

dziękuję za zgłoszenie.
Skieruje Pana zapytanie do programistów. Jak tylko otrzymam odpowiedź przekażę ją niezwłocznie.
Pozdrawiam,
Piotr

2019-08-21 16:57

Zgłoś naruszenie zasad

Dodaj komentarz