Przejdź do głównej treści
Gdy klient kontaktuje się z usługą CheckLists za pośrednictwem API, mogą wystąpić sytuacje, w których usługa lub rejestry wyszukiwania używane przez usługę są niedostępne. Aby poprawnie przetworzyć takie sytuacje, należy znać następujące informacje. W odpowiedzi na żądanie usługa zwraca odpowiedź HTTP o statusie. Analizując ją i strukturę odpowiedzi, można wyróżnić następujące sytuacje w działaniu usługi:
  • Status HTTP o kodzie z zakresu 500-599 – usługa CheckLists jest niedostępna lub nie działa poprawnie
  • Status HTTP o kodzie z zakresu 400-499 – usługa CheckLists jest dostępna, ale nie może przetworzyć żądania. W odpowiedzi, zamiast struktury opisanej powyżej, klient otrzyma następującą strukturę z opisem błędu:
  • error int
  • message string
Lista błędów:
messageerror
Użytkownik „user” nie istnieje.ACCOUNT_NOTFOUND = 1;
Adres „ip address” nie znajduje się na liście dozwolonych.NOT_ALLOW_IP = 2;
Dostęp testowy (promocyjny): limit żądań został wyczerpany lub upłynął okres ważności.TEST_ACCESS_END = 3;
Użytkownik „user” ma dostęp tylko za pośrednictwem zasobu sieciowego.SITEONLY = 6;
Data rozpoczęcia korzystania z usługi „start date” jeszcze nie nadeszła.ACCOUNT_NOT_ALLOWED_YET = 7;
„end date” – dozwolony okres korzystania z usługi upłynął.ACCOUNT_ACCESS_ENDS = 8;
Użytkownik „user” jest zablokowany.ACCOUNT_BLOCKED = 9;
Użytkownik „user” nie potwierdził rejestracji.ACCOUNT_NOT_CONFIRM = 10;
Limit żądań („limit żądań”) został wyczerpany.ACCOUNT_REQUEST_LIMIT_ENDS = 11;
Parametr „Data rozpoczęcia” do sprawdzania zmian w Jednolitym Rejestrze Stanowym Przedsiębiorców Indywidualnych i Jednoosobowych Działalności Gospodarczej nie jest poprawnie określony.REQUEST_BEGINDATE_ERROR = 103;
Parametr „Data zakończenia” do sprawdzania zmian w Jednolitym Rejestrze Stanowym Przedsiębiorców Indywidualnych i Jednoosobowych Działalności Gospodarczej nie jest poprawnie określony.REQUEST_ENDDATE_ERROR = 104;
Dolny limit parametru wejściowego lowranklimit do przeszukiwania bazy danych list sankcji nie jest poprawnie określony.REQUEST_LOWRANKLIMIT_ERROR = 105;
  • Status HTTP z kodem 200 - usługa CheckLists jest dostępna i może przetwarzać żądania od klientów. Struktura odpowiedzi może się różnić w zależności od dostępu do rejestrów wyszukiwania.
  • rejestr wyszukiwania, do którego uzyskujesz dostęp, działa, masz do niego dostęp, a przetwarzanie żądania nie przekracza czasu przeznaczonego na to - usługa zawsze zwraca wynik (strukturę opisaną powyżej w tekście lub pustą tablicę w przypadku braku wyników)
  • w przeciwnym razie w bloku odpowiedzi dla tego rejestru wyszukiwania, zamiast struktury odpowiedzi, klient może otrzymać SMS-a z błędem. Lista tych komunikatów i sytuacji, w których się pojawiają:
  • „9000.Brak połączenia z usługą” - rejestr wyszukiwania nie działa lub usługa nie jest z nim połączona
  • „9001.Dostęp do usługi jest zabroniony” - dostęp do rejestru wyszukiwania jest zabroniony, ponieważ nie jest on objęty pakietem usług, za który zapłaciłeś
  • „9003.Przetwarzanie żądania przekracza czas przeznaczony na to. Określ żądanie” - występuje, gdy przetwarzanie żądania do rejestru wyszukiwania przekracza czas przeznaczony na to
  • „9004.Brak połączenia z bazą danych usługi” - występuje, gdy usługa obsługująca rejestr jest dostępna, ale nie ma połączenia z bazą danych rejestru