Integracja klientów z fakturowni za pomocą webhooków

Utworzono: 2015-07-15
Ostatnia aktualizacja: 2015-07-15
Liczba odwiedzin posta: 2185

Czym jest webhook?

Webhooki to, obok interfejsu programistycznego API, mechanizm pozwalający na komunikację pomiędzy serwerami. Przeznaczone są głównie dla deweloperów i zaawansowanych użytkowników.

Czemu służą?

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

Webhook posiada:

 

  • typ - określa, kiedy webhook ma być wysyłany (po stworzeniu/zaktualizowaniu/usunięciu klienta)
  • URL - adres URL, pod który wyślemy webhooka
  • API token - token uwierzytelniający, który użytkownik może dodać do webhooka (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')
}

Zastosowanie w Fakturowni:
 

Ustawienia konta > Integracja > Webhooki



Powrót


Dodaj komentarz