Veřejné API

Veřejné API je ověřená integrační vrstva Blueputto. Zpřístupňuje stejné hlavní záznamy, se kterými aplikace každý den pracuje, což externím systémům umožňuje vytvářet, číst, aktualizovat a odstraňovat provozní data bez zavádění druhého obsahového modelu vedle UI.

Toto API běží pod /v1 a je navrženo pro práci s organizačními API klíči. Díky tomu jde o funkci, kterou týmy používají, když se data Blueputto potřebují přesunout do webu, automatizace, importního skriptu, interního dashboardu nebo jiného produktového systému.

Jedno verzované API pro hlavní prostředky workspace

Vstupní bod na /v1 vrací kompaktní discovery payload s verzí API, formátem ověřování, URL dokumentu OpenAPI a seznamem aktuálně zpřístupněných prostředků.

V aktuální implementaci veřejné rozhraní pokrývá:

• dokumenty,

• položky,

• kolekce,

• složky,

• kategorie,

• stavy,

• štítky,

• a šablony dokumentů.

Většina těchto prostředků podporuje standardní provozní postup seznam, získání, vytvoření, aktualizace a odstranění. API také zpřístupňuje akce specifické pro workflow tam, kde je UI potřebuje, například:

• obnovení a trvalé smazání pro dokumenty a položky,

• duplikaci pro dokumenty,

• změnu pořadí pro kategorie, stavy a štítky,

• a filtrování pouze aktivních pro šablony dokumentů.

Právě to dělá z Veřejného API víc než jen exportní vrstvu pouze pro čtení. Úzce odpovídá skutečnému životnímu cyklu záznamů, který je už viditelný přímo v Blueputto.

Kořenová odpověď Blueputto Public API a dokument OpenAPI pro verzované rozhraní API.

Ověřování a struktura odpovědí zůstávají předvídatelné

Veřejné API přijímá organizační přihlašovací údaj v jedné ze dvou standardních forem:

• x-api-key,

• nebo Authorization: Bearer <key>.

To dává týmům flexibilitu při napojování Blueputto do různých runtime prostředí, gatewayí a stylů SDK. Samotný klíč se vytváří uvnitř aplikace na stránce nastavení API klíčů.

Struktura odpovědí je také záměrně konzistentní. Odpovědi pro jeden prostředek jsou vraceny uvnitř obálky data. Endpointy seznamu vracejí data společně s meta, které zahrnuje detaily stránkování, jako jsou page, limit, total items, total pages a stav next nebo previous page.

Napříč aktuální sadou prostředků API také zpřístupňuje praktické filtry, které odrážejí skutečné workflow v UI, včetně search, deletedOnly, folderId, withoutFolder a activeOnly.

Autentizovaný požadavek Blueputto Public API zobrazující autentizaci pomocí API klíče a stránkované obálky odpovědí.

Postavené na stejných provozních pravidlech jako aplikace

Užitečná část Veřejného API Blueputto nespočívá jen v tom, že jsou záznamy externě dosažitelné. Jde také o to, že integrační rozhraní dodržuje stejná pravidla, která produkt už v UI vynucuje.

Například mazání dokumentů a položek je modelováno jako tok nejprve do koše, nikoli jako okamžité zničení. Některé operace s dokumenty mohou vrátit odpověď o uzamčeném stavu, když záznam právě není upravitelný. Omezení rychlosti je vynucováno pro každý API klíč, přičemž výchozí backend limit je momentálně nastaven na 5 req/s na klíč.

Díky tomu zůstává API v souladu se skutečným chováním aplikace. Externí integrace pracují se skutečným modelem prostředků Blueputto, ne se zjednodušeným vedlejším kanálem, který se chová jinak než produkt.

Související

• API Keys

• Documents

• Items

• Document Templates