API:Ověření
| Tato stránka je součástí dokumentace k API Action MediaWiki. |
| Verze MediaWiki: | ≥ 1.23 |
Parametr assert parametr Action API může být nastaven na jakýkoli požadavek API pro ověření určitých podmínek před provedením požadované akce.
Dostupné možnosti jsou:
assert=anon: Zkontrolujte, zda jednáte jako IP uživatel. Tím se zabrání náhodnému použití registrovaného účtu. Od MediaWiki 1.35 • change 572374assert=user: Zkontrolujte, zda používáte registrovaný účet (buď "pojmenovaný" nebo dočasný). Tím se zabrání náhodnému návratu k uživateli IP.assert=bot: Zkontrolujte, zda jste přihlášeni pomocí účtu, který má uživatelské právo "bot". To zabrání vašemu skriptu v interakci s wikinami, kde váš robot nemá příznak bota.assertuser=...: Zkontrolujte, zda jste přihlášeni s očekávaným uživatelským jménem. Od MediaWiki 1.28
Všimněte si, že dočasní uživatelé splňují assert=user a neuspějí assert=anon.
Možné chyby
Pokud tvrzení selže, bude vrácen jeden z následujících chybových kódů:
assertanonfailedassertuserfailedassertbotfailedassertnameduserfailed
Odůvodnění a případy použití
Tyto parametry jsou určeny jako druhá linie obrany proti dvěma druhům problémů:
Chyby operátora robota
Jednoduchá chyba operátora snadno způsobí mnoho špatných úprav, jako je například běh robota na nesprávné wiki nebo pod nesprávným uživatelským jménem, zvláště pokud spouštíte více úloh robota.
Parametry assert=bot a assertuser=... mají těmto chybám zabránit.
Vypršení platnosti relace přihlášení
Po přihlášení jsou soubory cookie, které obdržíte, platné pouze 30 dní ve výchozím nastavení, po této době bude váš robot odhlášen a může pokračovat v práci s jeho akcemi, které jsou atributy IP adresy nebo dočasného uživatelského jména (pokud je mohou provádět odhlášení uživatelé).
Parametr assert=user tomu má zabránit.
Přepínání uživatelských účtů
Interaktivní nástroje (v prohlížeči) využívající API k úpravám často chtějí zajistit, aby uživatel pochopil, jak bude jeho práce připisována.
Když se uživatel přihlásí nebo odhlásí na jiné kartě prohlížeče (nebo vyprší platnost jeho přihlašovací relace), neprojeví se to okamžitě v rozhraní nástroje, ale nová přihlašovací relace bude použita pro ukládání akcí.
Parametry assertuser=... a assert=anon mají umožnit detekci tohoto scénáře a zobrazení příslušné zprávy před pokračováním.
Ověření, zda-li jste přihlášení
Pokud chcete zkontrolovat, zda je váš HTTP klient přihlášen do Action API, aniž byste provedli jakoukoli jinou akci, můžete odeslat požadavek s parametry action=query&assert=user.
To vrátí prázdnou odpověď ({} ve formátu JSON), pokud jste skutečně přihlášeni, nebo chybu assertuserfailed, pokud ne.
Za normálních okolností nebudete muset provádět samostatný požadavek, jako je tento.
Místo toho u každého požadavku nastavte parametr assert=user.