Přehled pro vývojáře

Stránka Developer poskytuje přístup k dokumentaci API Shifton a nástrojům pro vytváření vlastních integrací.

Postup krok za krokem

Přístup ke stránce Developer

V levém bočním panelu klikněte na Integrace.

Přejděte na stránku Vývojář.

V horní části jsou tři záložky: Přehled, Webhooky a Žádosti.

Použití záložky Overview

Odkaz	Popis
lisá dokumentace	Aktuální dokumentace API
Staré dokumentace	Zastaralá dokumentace pro existující integrace

Klikněte na požadovaný odkaz — dokumentace se otevře na nové záložce.

Další záložky Developer

Webhooky

mdash; nastavte koncové body pro oznámení o událostech v reálném čase.

Žádosti

mdash; vytvářejte vlastní aplikace a spravujte je.

Související články

Často kladené otázky

Ot: Kterou dokumentaci používat — lisou nebo starou?
Použijte lisá dokumentace pro všechny nové integrace. Stará slouží pouze pro zpětnou kompatibilitu.

Ot: Stránka Vývojář se nezobrazuje — proč?
Stránka je dostupná pouze pro Ownera.

Ot: Existují omezení na počet požadavků na API?
Ano. Podrobnosti najdete v dokumentaci API.

Ot: Kde najít API klíč pro práci s směnaon API?
Integrations → Vývojář → Žádosti → vytvořte aplikaci → v nastavení získáte API credentials.

Ot: Podporuje směnaon OAuth 2.0?
Ano. Autorizace přes OAuth se používá pro připojení aplikací třetích stran. Podrobnosti v dokumentaci API.

Ot: Lze testovat API bez vytvoření aplikace?
Ano — použijte nástroje typu Postman s vašimi přihlašovacími údaji. Pro produkční prostředí se doporučuje zaregistrovat aplikaci.

Ot: Jaký je rozdíl mezi New a Staré dokumentace?
Nová dokumentace je aktuální (doporučena pro všechny nové integrace). Staré dokumentace slouží pro zpětnou kompatibilitu s existujícími integracemi.

Ot: Lze získat data reportů přes API?
Ano. API Shifton poskytuje přístup k datům rozvrhů, zaměstnanců a dalším zdrojům. Podrobnosti v dokumentaci.

Ot: Podporují Webhooky všechny typy událostí směnaon?
Ne, pouze určité. Seznam podporovaných událostí najdete v sekci Developer → Webhooks dokumentace.

Ot: Jsou nutné technické znalosti pro práci s API?
Ano. Pro práci s REST API a vytváření integrací přes Applications jsou nutné základní vývojářské dovednosti.

Ot: Je API placené nebo je součástí předplatného?
API je dostupné v rámci předplatného bez dodatečného poplatku. Omezení závisí na tarifním plánu.

Ot: Jak získat podporu při problémech s integrací přes API?
Obraťte se na podporu Shifton s popisem požadavku, odpovědi a kódu chyby. Též prostudujte dokumentaci na stránce Developer.

Ot: Jaká je základní URL pro API směnaon?
Základní URL je api2.shifton.com. Podrobnosti a příklady požadavků jsou v Nová dokumentace.

Ot: Podporuje API stránkování při dotazování velkých seznamů?
Ano. Podrobnosti implementace stránkování jsou popsány v dokumentaci API.

Ot: Lze přes API vytvářet a mazat směny?
Ano. API poskytuje plný CRUD přístup ke směnám, zaměstnancům, rozvrhům a dalším zdrojům.

Ot: Existuje sandbox prostředí pro testování API?
Speciální sandbox prostředí neexistuje. Doporučuje se vytvořit testovací společnost v Shifton pro bezpečné testování.

Ot: Jaké Vytvořitáty dat API podporuje?
API používá formát JSON pro požadavky a odpovědi.