Aktywacja API

1. Dostęp podstawowy i generowanie kluczy autoryzacji

Aby aktywować API iFirma zaloguj się do serwisu webowego.

Przejdź do zakładki Login ➡ Konfiguracja,

Następnie w menu po lewej stronie wybierz Rozszerzenia i integracje ➡ API

Jeśli po przejściu do wskazanej zakładki pojawia się poniższy komunikat:

Zweryfikuj czy masz aktywny jeden z pakietów iFirma, a w razie wątpliwości prześlij zapytanie e-mail, na adres bok@ifirma.pl. W korespondencji pamiętaj o wskazaniu loginu konta, którego dotyczy zapytanie.

Jeśli masz dostęp do wskazanej zakładki, w oknie które się pojawi wybierz Aktywuj dostęp podstawowy

W kolejnym kroku masz możliwość wygenerowania kluczy potrzebnych do komunikacji API: faktura, rachunek, abonent, wydatek. O ich wykorzystaniu dowiesz się z dokumentacji API

Aby wygenerować potrzebny klucz, wybierz odpowiednią opcję wygeneruj, przy danym kluczu API.

2. Dostęp rozszerzony i generowanie kluczy autoryzacji

Jeśli przy pierwszej aktywacji uznasz, że dostęp podstawowy jest niewystarczający, możesz aktywować dostęp rozszerzony.

Zaloguj się do serwisu webowego iFirma.pl.

Przejdź do zakładki Login ➡ Konfiguracja,

Następnie w menu po lewej stronie wybierz Rozszerzenia i integracje ➡ API

Jeśli masz dostęp do wskazanej zakładki, w oknie które się pojawi wybierz Dostęp rozszerzony

W polu, które się pojawi, zadeklaruj odpowiadający Ci limit i zatwierdź

Po przesłaniu wniosku o dostęp rozszerzony możesz otrzymać poniższy komunikat, jeśli limit będzie wymagał zatwierdzenia przez administratora.

Jeśli wnioskowany limit zostanie przyznany, będzie możliwe wygenerowanie kluczy autoryzacji.
Aby wygenerować potrzebny klucz, wybierz odpowiednią opcję wygeneruj przy danym kluczu API.

O wykorzystaniu kluczy dowiesz się z dokumentacji API

3. Zwiększenie limitu API

Jeśli w trakcie użytkowania limit podstawowy okaże się niewystarczający, można rozszerzyć dostęp i zwiększyć miesięczny limit. Zwiększenie limitu może wymagać zatwierdzenia, co wydłuża proces aktywacji, dlatego wniosek warto złożyć z wyprzedzeniem, aby uniknąć przestoju w komunikacji API. W tym celu zaloguj się do serwisu webowego iFirma.

Przejdź do zakładki Login ➡ Konfiguracja,

Następnie w menu po lewej stronie wybierz Rozszerzenia i integracje ➡ API

W zakładce wybierz sekcję Limity API

Po rozwinięciu sekcji Limity API uzupełnij pole z wnioskowany limitem i zatwierdź.

Jeśli limit zostanie przyznany automatycznie, po wybraniu opcji zatwierdź wartość wnioskowanego limitu i przyznanego limitu ulegną zmianie w komunikacie.

Jeśli wnioskowany limit będzie wymagał akceptacji administratora, po wybraniu opcji zatwierdź, pojawi się odpowiedni komunikat a wnioskowany limit i przyznany limit, będą miały różne wartości.

Po akceptacji administracyjnej widok sekcji Limity API zmieni się, a przyznany limit będzie widoczny w komunikacie.

4. Ponowne wygenerowanie kluczy autoryzacji

Jeśli w trakcie korzystania z dotychczasowych kluczy pojawią się błędy w komunikacji API lub otrzymasz wskazanie do ponownego wygenerowania kluczy API, postępuj zgodnie z poniższą instrukcją:
Zaloguj się do serwisu webowego iFirma.pl.

Przejdź do zakładki Login ➡ Konfiguracja,

Następnie w menu po lewej stronie wybierz Rozszerzenia i integracje ➡ API

Przy kluczu, z którego korzystasz w integracji wybierz opcję przegeneruj. Użyj nowo wygenerowanego klucza w komunikacji z serwisem iFirma.

Autor: Łukasz Wróbel – ifirma.pl