Możliwe funkcje:
- zarejestrowanie nowego użytkownika przez partnera
- wysyłanie wiadomości e-mail do nowo zarejestrowanego użytkownika z loginem oraz hasłem do serwisu
Aby prawidłowo wysłać żądanie rejestracji, niezbędne są: nazwa partnera oraz klucz autoryzacji partnera ( symetryczny wygenerowany w serwisie lub asymetryczny wygenerowany samodzielnie przez użytkownika). Klucze generowane i podawane są w panelu administracyjnym użytkownika. Klucz symetryczny jest kluczem publicznym, natomiast klucz asymetryczny wymaga znajomości klucza prywatnego dzięki czemu sposób kodowania jest bezpieczniejszy. Klucz można w razie potrzeby przegenerować.
Przykładowa zawartość żądania (json):
| Nazwa w xml @XmlElement(class="Nazwa") lub w json @JsonProperty(value = "Nazwa") |
Typ danych |
Wartości |
Opis |
|
Login
|
String |
>= 6 znaków; <= 15 znaków; null - daje wygenerowany automatycznie login |
N |
Login rejestrowanego użytkownika |
| PierwszyMiesiacKsiegowania |
Integer |
<= 2 cyrfy; null - miesiąc bieżący |
T |
Pierwszy miesiąc księgowania w serwisie |
| PierwszyRokKsiegowania |
Integer |
<= 4 cyfry; null - rok bieżący |
T |
Pierwszy rok księgowania w serwisie |
| FormaPrawna |
String |
OF (osoba fizyczna); SC ( spółka cywilna) |
T |
Forma prawna rejestrowanego użytkownika |
| RozpVatowiec |
Boolean |
true; false |
T |
Czy rejestrowany użytkownik jest płatnikiem VAT |
| Email |
String |
<= 50 znaków |
T |
Adres e-mail rejestrowanego użytkownika |
| HasloPromocji |
String |
<= 50 znaków |
N |
Hasło promocji jeśli nadano |
| RokRozpoczeciaVatowiec |
Integer |
<= 4 cyfry; null - rok bieżący |
N |
Rok rozpoczęcia działalności gospodarczej rejestrowanego użytkownika jako płatnik VAT |
| MiesiacRozpoczeciaVatowiec |
Integer |
<=2 cyfry; null - miesiąc bieżący |
N |
Miesiąc rozpoczęcia działalności gospodarczej rejestrowanego użytkownika jako płatnik VAT |
| RokRozpoczeciaDzialalnosci |
Integer |
<= 4 cyfry |
T |
Rok rozpoczęcia działalności gospodarczej rejestrowanego użytkownika |
| MiesiacRozpoczeciaDzialalnosci |
Integer |
<= 2 cyfry |
T |
Miesiąc rozpoczęcia działalności gospodarczej rejestrowanego użytkownika |
| NazwaFirmyPelna |
String |
<= 150 znaków |
N |
Pełna nazwa firmy rejestrowanego użytkownika |
| NazwaFirmySkrocona |
String |
<= 100 znaków |
N |
Skrócona nazwa firmy rejestrowanego użytkownika |
| Telefon |
String |
<= 30 znaków |
N |
Numer telefonu rejestrowanego użytkownika |
| Regon |
String |
<=9 znaków |
N |
Numer REGON rejestrowanego użytkownika |
| NIP |
String |
>= 10 znaków; <=13 znaków |
N |
Numer NIP rejestrowanego użytkownika |
| Wojewodztwo |
String |
<= 25 znaków |
N |
Województwo rejestrowanego użytkownika |
| Gmina |
String |
<= 30 znaków |
N |
Gmina rejestrowanego użytkownika |
| Powiat |
String |
<= 30 znaków |
N |
Powiat rejestrowanego użytkownika |
|
| Miejscowosc |
String |
<=35 znaków |
N |
Miejscowość rejestrowanego użytkownika |
| Poczta |
String |
<=30 znaków |
N |
Poczta rejestrowanego użytkownika |
| KodPocztowy |
String |
<= 6 znaków |
N |
Kod pocztowy rejestrowanego użytkownika |
| Ulica |
String |
<= 50 znaków |
N |
Ulica rejestrowanego użytkownika |
| NumerDomu |
String |
<=9 znaków |
N |
Numer domu rejestrowanego użytkownika |
| NumerLokalu |
String |
<= 10 znaków |
N |
Numer lokalu rejestrowanego użytkownika |
|
Wlasciciel (gdy formaPrawna = OF)
|
| ImieWlasciciela |
String |
<=30 znaków |
N |
Imię właściciela firmy rejestrowanego użytkownika |
| NazwiskoWlasciciela |
String |
<= 30 znaków |
N |
Nazwisko właściciela firmy rejestrowanego użytkownika |
W celu rejestracji należy skonstruować request (POST) w formacie JSON. Request jest zestawem danych rejestracji przedstawionym za pomocą tablicy w formacie danych przedstawionym wyżej.
URL ma postać:
https://www.ifirma.pl/iapi/abonent/rejestracja
Podawany nagłówek Authentication ma postać:
a) w przypadku klucza symetrycznego:
HashWiadomosci powinien być zapisany w postaci heksadecymalnej.
b) w przypadku klucza asymetrycznego:
Przykład żądania POST (PHP):
gdzie:
-
klucz - wygenerowany klucz autoryzacji
-
url - url pod który wysyłamy requesta
-
nazwaUsera
- nazwa partnera serwisu ifirma.pl
-
nazwaKlucza - identyfiktorKlucza - wartość 'abonent'
-
requestContent
- zawartość requesta
W rezultacie zarejestrowany użytkownik otrzymuje hasło oraz login do serwisu ifirma.pl na podany w żądaniu adres e-mail.
Nie wiesz jak możesz wykorzystać możliwości, które daje Ci API? Pomożemy Ci! Zapoznaj się z usługami integracji systemów.