Dokumentacja API: CRBR import
Wersja 1.1
Autoryzacja
Autoryzacja do API modułu CRBR import, podobnie jak inne moduły dostępne przez API Platformy usługowej HyperFlow, odbywa się za pomocą Klucza API wysłanego w nagłówku żądania o nazwie HFAPIKEY.
Wygenerowany klucz musi posiadać status Aktywny oraz mieć przypisany włączony dostęp do modułu CRBR import.
Poprawna konfiguracja Klucza API dla potrzeb CRBR import![](https://lh6.googleusercontent.com/AvkFGS7eAXUgs8vdc6UKH8xMpC1wKMzhllbxogDqEeHcDhl9TgWYNVoP1BOo-9wri6rhi2c1_JM-LWv2zgyRDot6reQjZIp0KXuh0SAIFtkwsfl8Yizvnmn8XhPURP01dPDbNSDC)
Szczegóły na temat konfiguracji klucza są dostępne w dokumentacji użytkownika Platformy usługowej HyperFlow rozdział 9. Klucze API.
Dostępne komendy
Zapytanie w CRBR o NIP – pojedyncze
Komenda | Zapytanie w Centralnym Rejestrze Beneficjentów Rzeczywistych – pojedyncze |
Metoda HTTP | POST |
URI | https://hyperflow.eu/api/route/crbrimport |
Format żądania (Request format) | JSON |
Format odpowiedzi (Response format) | JSON |
Kodowanie znaków | UTF-8 |
Parametry | Obiekt (JSON) zawierający pole nip |
Przykład żądania:{
"nip":"1234567890"
}
Przykład odpowiedzi:{
"companyName": "XYZ S.A.",
"vatno": "1234567890",
"krs": "0000123456",
"legalForm": "Spółka akcyjna",
"legalFormType": "Osoba Prawna",
"postCode": "00-010",
"city": "Warszawa",
"address": "ul. Franklina Roosevelta 1",
"beneficialowners": [
{
"firstName": "Jacek",
"secondName": "Kanrad",
"lastName": "Kowalski",
"pesel": "80080812345",
"nin": null,
"dateOfBirth": null,
"country": "PL",
"pepStatus": "Nieokreślony",
"nationality": "PL",
"personId": "80080812345"
},
{
"firstName": "Robert",
"secondName": "",
"lastName": "Iksiński",
"pesel": "72020712345",
"nin": null,
"dateOfBirth": null,
"country": "PL",
"pepStatus": "Nieokreślony",
"nationality": "PL",
"personId": "72020712345"
}
],
"principles": [
{
"firstName": "Jacek",
"secondName": "Kanrad",
"lastName": "Kowalski",
"pesel": "80080812345",
"nin": null,
"dateOfBirth": null,
"country": "PL",
"pepStatus": "Nieokreślony",
"nationality": "PL",
"personId": "80080812345"
},
{
"firstName": "Robert",
"secondName": "",
"lastName": "Iksiński",
"pesel": "72020712345",
"nin": null,
"dateOfBirth": null,
"country": "PL",
"pepStatus": "Nieokreślony",
"nationality": "PL",
"personId": "72020712345"
}
],
"nip": "7822622168",
"status": "ok",
"result": "ok",
"consumeId": "7418"
}
Zapytanie w CRBR o NIP – masowe – tablica JSON
Komenda | Zapytanie w CRBR zbiorowe – JSON Array |
Metoda HTTP | POST |
URI | https://hyperflow.eu/api/route/crbrbatch |
Format żądania (Request format) | JSON |
Format odpowiedzi (Reponse format) | JSON |
Kodowanie znaków | UTF-8 |
Parametry | Tablic JSON Array, zawierająca obiekty z polem: nip |
Przykład żądania:[
{
"nip": "0123456789"
},
{
"nip": "1234567890"
}
]
Przykład odpowiedzi:{
"result": "ok",
"reports": [
{
"companyName": "XYZ S.A.",
"vatno": "1234567890",
"krs": "0000123456",
"legalForm": "Spółka akcyjna",
"legalFormType": "Osoba Prawna",
"postCode": "00-010",
"city": "Warszawa",
"address": "ul. Franklina Roosevelta 1",
"beneficialowners": [
{
"firstName": "Jacek",
"secondName": "Kanrad",
"lastName": "Kowalski",
"pesel": "80080812345",
"nin": null,
"dateOfBirth": null,
"country": "PL",
"pepStatus": "Nieokreślony",
"nationality": "PL",
"personId": "80080812345"
},
{
"firstName": "Robert",
"secondName": "",
"lastName": "Iksiński"
"pesel": "72020712345",
"nin": null,
"dateOfBirth": null,
"country": "PL",
"pepStatus": "Nieokreślony",
"nationality": "PL",
"personId": "72020712345"
}
],
"principles": [
{
"firstName": "Jacek",
"secondName": "Kanrad",
"lastName": "Kowalski",
"pesel": "80080812345",
"nin": null,
"dateOfBirth": null,
"country": "PL",
"pepStatus": "Nieokreślony",
"nationality": "PL",
"personId": "80080812345"
},
{
"firstName": "Robert",
"secondName": "",
"lastName": "Iksiński",
"pesel": "72020712345",
"nin": null,
"dateOfBirth": null,
"country": "PL",
"pepStatus": "Nieokreślony",
"nationality": "PL",
"personId": "72020712345"
}
],
"nip": "7822622168",
"status": "ok",
"result": "ok",
"consumeId": "7418"
},
{
"companyName": "ABC SA",
"vatno": "0123456789",
"krs": "0000001234",
"legalForm": "Spółka akcyjna",|
"legalFormType": "Osoba Prawna",
"postCode": "12-345",
"city": "Kozienice",
"address": "ul. Komunalna 10",
"beneficialowners": [
{
"firstName": "Jan",
"secondName": "Artur",
"lastName": "Nowak",
"pesel": "79000001111",
"nin": null,
"dateOfBirth": null,
"country": "PL",
"pepStatus": "Nieokreślony",
"nationality": "PL",
"personId": "79000001111"
}
],
"principles": [ ],
"nip": "8650004194",
"status": "ok",
"result": "ok",
"consumeId": "7440",
"date": "2020-05-27",
"resp": "ok"
}
]
}
Uwagi implementacyjne
Żądanie przyjmuje tablicę obiektów z których każdy posiada atrybut nip.
- Atrybut nip– białe znaki i znak myślnika są usuwane
Dodanie numeru NIP do bufora analizy
Komenda | Dodanie numeru NIP do bufora automatycznej analizy |
Metoda HTTP | POST |
URI | https://hyperflow.eu/api/route/datasource/ datainput/crbrimport/ |
Format żądania (Request format) | JSON |
Format odpowiedzi (Response format) | JSON |
Kodowanie znaków | UTF-8 |
Parametry | Obiekt (JSON) zawierający pole nip |
Przykład żądania:{
"nip":"1234567890"
}
Przykład odpowiedzi:{
"result": "ok",
"msg": "Data saved"
}
Przykłady wywołania za pomocą klienta RESTED
Zapytanie pojedyncze
Zapytanie JSON Array
Dodanie numeru NIP do bufora analizy
![](https://pl.hyperflow.eu/wp-content/uploads/2020/06/api1-1024x539.png)
Kody błędów
Przykład kodu:{
"code": "0000",
"redirect": "",
"result": "err",
"msg": "Access denied"
}
Przyczyny:
- Błędny klucz API
- Nieaktywny klucz API,
Przykład kodu:{
"code": "0089",
"redirect": "",
"result": "err",
"msg": "Brak dostępu do usługi"
}
Przyczyny:
- Użytkownik zużył całą pulę wykupionych zapytań lub termin, do którego usługa została wykupiona minął,
- Nieaktywny klucz API,
- Klucz API nie ma włączonej usługi CRBR import.
Przykład kodu:{
"code": "eVatNo",
"redirect": "",
"result": "err",
"msg": "Pole Vat/NIP nie może być puste."
}
Przypadki:
- Niewłaściwie wprowadzona nazwa parametru: „nip”,
- Niewłaściwy parametr dla żądania URI,
- Parametr „nip” jest pusty,
- Brak parametru w żądaniu,
- Wybrana metoda jest niewłaściwa dla zapytania (POST/GET).
Przykład kodu:{
"code": "bVatNo",
"redirect": "",
"result": "err",
"msg": "Niepoprawny NIP"
}
Przypadki:
- Nieprawidłowa ilość znaków w parametrze “nip”,
- Niedozwolone znaki w parametrze “nip” (dopuszcza się spacje i myślniki),
- Niewłaściwa suma kontrolna numeru nip.
Przykład kodu:{
"code": "bData",
"redirect": "",
"result": "err",
"msg": "Błędne dane"
}
Przypadki:
- Niewłaściwie wprowadzona nazwa parametru: „nip”,
- Niewłaściwy parametr dla żądania URI,
- Parametr „nip” jest pusty.
Przykład kodu:{
"code": "1233",
"redirect": "",
"result": "err",
"msg": "Nieznana komenda"
}
Przypadki:
- Niewłaściwie wprowadzone URI,
- Wybrana metoda jest niewłaściwa dla zapytania (POST/GET).