Pro fungování API, resp. bylo možné na něj zasílat dotazy, je třeba mít aktivovánu licenci na použití S5 API.
Pokud nemá uživatel Money S4/S5 aktivovánu licenci na použití API nebo je obecně problém s právy, vrátí S5 API na daný dotaz chybu 500 Internal Server Error. Případně lze změnou údaje v config souboru „ShowPII“: true získat více informací do log souboru.
Pokud je licence v pořádku, tak obvykle bývá problém s právy SQL na DB API. Možným řešením, může být tyto DB smazat, vytvořit je ručně pod SQL uživatelem, který bude použit pro instalaci API a následně provést instalaci API na tyto již vytvořené DB.
URL adresa webového serveru (vč. komunikačního protokolu a čísla portu), na kterém je nainstalované API, např. http://demo.moneys5.cz:81
Upozornění před limitem limit pro upozornění uživatele (Již se nepoužívá)
Email e-mailová adresa, na kterou se odešle upozornění (Již se nepoužívá)
Typ zprávy šablona pro odesílání zpráv (Již se nepoužívá)
(Již se nepoužívá) Součástí licence může být limit povolených přístupů (pro zápis) přes API. V tomto poli lze nastavit počet přístupů přes API, přičemž při jeho dosažení Money odešle na adresu zadanou v poli Email upozornění o blížícím se vypršení limitu, druhé upozornění pak odešle při překročení poloviny nastaveného počtu přístupů.
Test spojení: test spojení na S5 API (pokud je IIS v suspend módu, může trvat déle)
Verze API: zde se po úspěšném testu zobrazí verze S5 API
Verze API slouží pro kontrolu, zda verze API odpovídá verzi Money. Pokud je verze API starší, než verze Money, důrazně doporučujeme provést co nejdříve jeho aktualizaci, jinak může docházet k chybám při přenosu dat přes API.
Nastavení uživatelských práv API
Administrace/Přístupová práva/Uživatelské role API
V Money S4/S5 je třeba definovat uživatelské role API.
Dokud není úspěšně proveden Test spojení (viz Karta konfigurace API), nelze uživatelské role API definovat, protože se propisují do databáze API – systém zobrazí chybové hlášení:
Pokud nejsou v Money S4/S5 nastavena odpovídající uživatelská práva API, vrátí S5 API na daný dotaz chybu 403 Forbidden.
REST API
Uživatelská práva pro API se nastavují na jednotlivé endpointy. Standardní uživatelská práva Money se neaplikují.
GraphQL
Uživatelská práva pro API se aplikují dle nastavení standardních uživatelských práv Money.
V uživatelských právech pro API je třeba mít povolený /GraphQL endpoint, resp. /GraphQL/Schema endpoint pro přístup ke schématu a /GraphQL/GraphQLDoc endpoint pro přístup k dokumentaci.
Takto vypadá fungující API
Pro zobrazení dokumentace swagger nebo pro GrapQL je nutné vhodně konfigurovat soubory web.config a index.html viz sekce Nastavení prostředí.