Konfiguracja połączenia (Plus OCR)

Opis ogólny

W celu rozpoczęcia pracy ze wtyczką konieczne jest skonfigurowanie połączenia z dostawcą systemu OCR. Konfiguracja połączeń znajduje się w module "Zarządzanie konfiguracjami wtyczek" (PCM) w administracji.

Zmiany w konfiguracji od wersji 1.0.26

Nowa konfiguracja wtyczki w PCM została dodana w wersji 1.0.26. Utworzy się ona automatycznie, bazując na starszej konfiguracji. Nie są wymagane żadne działania ze strony użytkownika.

We wcześniejszych wersjach wtyczki wszystkie parametry były określane w sekcji "Parametry systemowe". Po aktualizacji do wersji 1.0.26, parametry systemowe dla skanuj.to: "ApiUrl", "CompanyId", "Login" oraz "Password" zostają usunięte, a ich wartość zostanie przeniesiona do konfiguracji PCM.

Od wersji 1.0.26 w parametrach systemowych znajdują się dwie wartości: "PlusOCR.Alphamoon.ApiKey" w sekcji "PlusOCR.Alphamoon" (tak jak poprzednio), oraz nowy parametr "PlusOCR.SkanujTo.ApiKey" w sekcji "PlusOCR.SkanujTo". Wraz z nowym parametrem dochodzi możliwość korzystania z kluczy API systemu skanuj.to

Parametry systemowe

Przykładowa konfiguracja

Konfiguracja SkanujTo wymaga uzupełnienia parametrów: "Adres Url", "Id firmy", "Login", oraz jednego z parametrów: "Hasło" albo "Klucz API".

Konfiguracja Alphamoon korzysta domyślnie z dotychczasowego parametru systemowego "PlusOCR.Alphamoon.ApiKey".

W parametrach konfiguracyjnych nie trzeba podawać bezpośrednio danych - można wykorzystać parametry systemowe do "ukrycia" wybranych wartości. Jeżeli chcemy wykorzystać parametr systemowy, to musimy użyć następującej składni:

"parametr": "SYSTEM_PARAMETER:Klucz.Parametru.Systemowego"

Nowa konfiguracja klucza API dla dostawcy Alphamoon domyślnie wskazuje na parametr systemowy:

"alphamoon": {
  "apiKey": "SYSTEM_PARAMETER:PlusOCR.Alphamoon.ApiKey"
}

Przykładowy JSON

{
  "skanujTo": {
    "apiKey": "",
    "apiUrl": "https://app.skanuj.to/api/",
    "companyId": "1234567890",
    "login": "login",
    "password": "password"
  },
  "alphamoon": {
    "apiKey": "SYSTEM_PARAMETER:PlusOCR.Alphamoon.ApiKey"
  }
}

Parametry PCM

Konfiguracja parametrów skanuj.to

Uwaga: wymagane jest uzupełnienie przynajmniej jednego parametru z grupy: Klucz API, Hasło. Pozostałe parametry powinny być uzupełnione niezależnie od wyboru sposobu autoryzacji.

Parametr	Opis
Klucz API	Klucz API znajdujący się w zakładce "Integracje" w ustawieniach konta na stronie skanuj.to
Adres Url	Link do API w serwisie skanuj.to (np. https://app.skanuj.to/api/)
Id firmy	Identyfikator firmy, do której wgrywane będą dokumenty
Login	Nazwa użytkownika
Hasło	Hasło użytkownika.

Konfiguracja parametrów alphamoon.ai

Parametr	Opis
Klucz API	Klucz API od dostawcy alphamoon. Poradnik dot. wygenerowania klucza znajduje się na stronie głównej wtyczki