Wykorzystaj do tego Akcję “Data transfer”.
Czym jest “Transfer danych”?
Akcja “Data transfer” pozwala na wysyłanie danych do określonego URL w momencie wystąpienia pewnych zdarzeń (ustalonych na workflow). W przeciwieństwie do tradycyjnego API, które wymaga okresowego odpytywania, aby sprawdzić, czy nastąpiła zmiana, webhooki automatycznie wysyłają informacje, gdy tylko wystąpi określone zdarzenie.
Za pomocą akcji “Data transfer” można przesłać do zewnętrznej aplikacji (metoda POST) wybrane przez siebie dane z procesu (np. imię i nazwisko pracownika, data jego zatrudnienia lub inne dane, które zostały zebrane w czasie jego procesu).
Aplikacja odbierająca musi potrafić wyświetać wszystkie otrzymane zapytania HTTP, które zostały wysłane na ten unikalny URL. Dla testów akcji “Data transfer” można skorzystać z serwisu https://webhook.site/, który:
- automatycznie wygeneruje unikalny URL. Ten URL działa jako “endpoint”, czyli punkt końcowy, na który aplikacje mogą wysyłać dane.
- otrzyma i wyświetli wszystkie otrzymane zapytania HTTP, które zostały wysłane na ten unikalny URL za pomocą akcji “Data transfer”
W akcji “Data transfer” można skorzystać z funkcji “Send test”, która wysyła na podany URL testowe dane oraz kształt JSONa.
W przypadku wysyłania plików, akcja “Data transfer” zwróci do odbiorcy adres URL do pliku, który umożliwia jego pobranie. Do pobrania pliku konieczne jest posiadanie kluczy API KEY oraz API SECRET (możesz to zrobić tutaj: https://gamfi.support/help/quickstart), które służą do autoryzacji podczas pobierania.
Aby pobrać raport z listą procesów z aplikacji Gamfi skorzystaj z metody i endpointa:
GET + URL zwrócony przez akcję ”Data transfer”
Przykładowy cURL:
curl --location '' \
--header 'X-Samus-Authorization-Api-Key: {apiKey}' \
--header 'X-Samus-Authorization-Api-Secret: {apiSecret}' \
--header 'Content-Type: application/json'
W miejscu:
- {URL} - zwrócony przez akcję ”Data transfer” URL do pliku
- {apiKey} - wstaw klucz API
- {apiSecret} - wstaw sekret API
W przypadku prawidłowej odpowiedzi (200) rozpocznie się pobieranie pliku.