Základy API a přihlášení

Před prvním voláním API je potřeba vyřešit dvě věci: kdo se hlásí a co smí. Tato část vysvětluje, k čemu API v redakčním systému slouží, jak se vydávají a používají přístupové údaje a jak se oprávnění váže na role uživatelů a na konkrétní web. Součástí je i popis chybových odpovědí, takže při ladění poznáte, jestli je problém v přihlášení, v oprávnění, nebo ve tvaru požadavku.

Nejčastější chyba při rozjezdu je začít u endpointů a přihlášení dořešit později. Vyplatí se to obrátit. Nejdřív si ujasněte účel napojení, k tomu slouží text API: k čemu slouží a kdy ho potřebujete, a potom nastavte přístup podle článku API: přihlášení a oprávnění. Odpadne tím většina pozdějšího hledání, proč požadavek vrací zamítnutí.

Oprávnění pro API vychází ze stejné logiky jako práce lidí v administraci. Uživatel má roli a role určuje, co může na daném webu dělat. Podrobný rozpis najdete v části role a oprávnění. U licence, která pokrývá víc webů, je dobré držet přístupy oddělené, aby napojení jednoho projektu nemohlo zapisovat do ostatních.

Odpovědi na obvyklé dotazy

Kde získám přístupové údaje? Vydávají se v administraci, do které se přihlásíte běžným způsobem popsaným v článku Registrace a přihlášení do administrace.

Co když požadavek vrací chybu o přihlášení? Zkontrolujte v tomto pořadí platnost údajů, správnou hlavičku a to, jestli má uživatel oprávnění na daný web. Chybové kódy jsou vypsané v REST API specifikaci v1.

Mám počítat s omezením počtu požadavků? Napojení navrhujte tak, aby posílalo data v dávkách. Volání pro každou položku zvlášť se hůř ladí a víc zatěžuje provoz. Podmínky platné pro váš tarif ověříte v ceníku.

Jak přístup zruším, když napojení končí? Údaje se dají zneplatnit v administraci. Doporučujeme to udělat vždy při ukončení spolupráce s dodavatelem, který napojení stavěl.