Dokumentacja techniczna API

1. Punkt dostępowy

Punkt dostępowy API znajduje się pod adresem:

https://www.wyszukiwarkakrs.pl/api

Należy zwrócić uwagę, że dostęp odbywa się szyfrowanym połączeniem https.

2. Uwierzytelnianie

Klucz dostępu do API zostaje wygenerowany dla klienta po wykupieniu dostępu. Klucz powinien być przekazywany jako parameter w adresie [parameter key].

3. Kodowanie znaków

Każdy string przekazany do API musi być kodowany w UTF-8.

4. Kody błędów

Rezultat wykonanego zapytania można określić na podstawie kodu błędu HTTP. W Wyszukiwarkakrs API używane są następujące kody:
Kod odpowiedzi Odpowiedź Opis
200 OK Zapytanie zostało wykonane poprawnie.
401 Unauthorized Brak autoryzacji lub uprawnień do danego zasobu.
404 Not Found Zasób nie został odnaleziony.

5. Wyszukiwanie

API umożliwia dostęp do pojedynczych profili KRS spółek poprzez zapytanie:

https://www.wyszukiwarkakrs.pl/api/key/krs

Istnieje możliwość pobrania danych z poszczególnych działów KRS profilu spółki:

https://www.wyszukiwarkakrs.pl/api/key/krs/dz

lub poszczególnych rubryk KRS profilu spółki:

https://www.wyszukiwarkakrs.pl/api/key/krs/dz/rub

Każde zapytanie zwracana dane w formacie JSON.

Parametr Opis
key klucz dostępu
krs 10-cyforwy numer KRS (np. 0000450260)
dz dział KRS (od 1 do 6)
rub rubryka KRS (od 1 do 11)

6. Środowisko testowe

Parametr Opis
key 01234567890123456789012345678901
krs 0000450260

7. Przykłady

Pobranie rubryki z profilu KRS spółki:

https://www.wyszukiwarkakrs.pl/api/01234567890123456789012345678901/0000450260/1/1

Pobranie działu z profilu KRS spółki:

https://www.wyszukiwarkakrs.pl/api/01234567890123456789012345678901/0000450260/1

Pobranie profilu KRS spółki:

https://www.wyszukiwarkakrs.pl/api/01234567890123456789012345678901/0000450260