Kto może korzystać z tej funkcji?
Dostępne w planie Enterprise.
Dostępne dla właścicieli i administratorów w aplikacji internetowej.
Aby korzystać z API Fax.Plus, musisz najpierw autoryzować dostęp API do swojego konta. Po zakończeniu procesu autoryzacji możesz zalogować się do swojego konta.
Istnieją dwie różne metody uwierzytelniania:
- Wygeneruj i użyj osobistych tokenów dostępu.
- Skorzystaj z przepływu OAuth 2.0.
Osobisty token dostępu może być używany jako metoda uwierzytelniania w celu bezpiecznego dostępu do API Fax.Plus. Ten token działa jak podpis cyfrowy, umożliwiając wysyłanie autoryzowanych żądań do naszego API, co pozwala na wykonywanie takich czynności jak wysyłanie faksów oraz pobieranie danych dotyczących Twoich faksów.
Aby wygenerować nowy osobisty token dostępu, wykonaj następujące kroki:
- Zaloguj się na swoje konto Fax.Plus i przejdź do sekcji Ustawienia na swoim panelu.
- Znajdź zakładkę Integracje.
- W sekcji Fax.Plus API znajdź opcję Osobiste tokeny dostępu i kliknij Zarządzaj.
- Kliknij Generuj token i określ nazwę tokena, datę wygaśnięcia oraz zakresy uprawnień (jako zakresy tokena wybierz zarówno edycję, jak i odczyt).
- Pamiętaj, aby teraz skopiować swój osobisty token dostępu — w przeciwnym razie nie będzie już możliwości ponownego wyświetlenia go.
Krok 1: Skonfiguruj początkowy przepływ uwierzytelniania
- Zaloguj się na swoje konto Fax.Plus i przejdź do sekcji Ustawienia na swoim panelu.
- Znajdź zakładkę Integracje.
- W sekcji Fax.Plus API kliknij Aktywuj i zbierz następujące dane:
- Client ID (zaczyna się od APIK-)
- Client secret
- Redirect URI (jeden z nich)
- Aby zainicjować proces autoryzacji dostępu API do Twojego konta, po prostu kliknij podany w tym kroku link za pomocą przeglądarki internetowej. Ten link przekieruje Cię do ekranu, na którym możesz udzielić niezbędnych uprawnień: https://accounts.fax.plus/login?response_type=code&client_id=[client ID]&redirect_uri=[redirect URI]&scope=all
-
Po udzieleniu uprawnień nastąpi przekierowanie na podany przez Ciebie adres URL, wraz z kodem autoryzacyjnym przekazanym jako parametr URL:
Krok 2: Wyślij żądanie HTTP POST
Po pomyślnym autoryzowaniu dostępu możesz przejść do wykonania żądania HTTP POST na następujący adres URL: https://accounts.fax.plus/token?grant_type=authorization_code&client_id=[client ID]&code=[authorization code]&redirect_uri=[redirect URI].
Pamiętaj, aby dołączyć do żądania następujące nagłówki:
-
- Content-Type: application/x-www-form-urlencoded
- Authorization: Basic [base64-encoded string of "client_id:client_secret"]
- Content-Type: application/x-www-form-urlencoded
Po zakończeniu tego procesu otrzymasz odpowiedź zawierającą token dostępu, który jest ważny przez 1 godzinę, a także token odświeżający o nieograniczonej ważności.
Uwaga: Jeśli na Twoim koncie Fax.Plus jest aktywna funkcja Advanced Security Controls, token odświeżający jest ważny przez 30 dni, zgodnie z przepisami bezpieczeństwa. Oznacza to, że trzeba będzie powtarzać ten proces co 30 dni, aby uzyskać nowy token odświeżający.
Krok 3: Uzyskaj nowy token dostępu
Po wygaśnięciu tokena dostępu możesz uzyskać nowy, korzystając z tokena odświeżającego, poprzez wykonanie żądania HTTP POST na następujący adres URL: https://accounts.fax.plus/token?grant_type=refresh_token&refresh_token=[refresh token].
Ten proces wymaga dołączenia następujących nagłówków:
-
- Content-Type: application/x-www-form-urlencoded
- Authorization: Basic [base64-encoded string of "client_id:client_secret"]
Po uzyskaniu tokena dostępu wszystkie kolejne wywołania API będą wymagać następujących nagłówków:
-
- Authorization: Bearer [access token]
- x-fax-clientid: [client ID]