Prehľad pre vývojárov

Stránka Developer otvára prístup k dokumentácii API Shifton a nástrojom na vytváranie vlastných integrácií.

Postup krok za krokom

Prístup k stránke Developer

Na ľavom bočnom paneli kliknite na Integrácie.

Prejdite na stránku Vývojár.

V hornej časti sú tri záložky: Prehľad, Webhooky a Žiadosti.

Používanie záložky Overview

Odkaz	Popis
Nová dokumentácia	Aktuálna dokumentácia API
Staré dokumenty	Zastaraná dokumentácia pre existujúce integrácie

Kliknite na požadovaný odkaz — dokumentácia sa otvorí v novej záložke.

Ďalšie záložky Developer

Webhooky

mdash; nastavte koncové body na notifikácie o udalostiach v reálnom čase.

Žiadosti

mdash; vytvárajte vlastné aplikácie a spravujte ich.

Súvisiace články

Často kladené otázky

Ot.: Ktorú dokumentáciu použiť — novú alebo starú?
Použite Nová dokumentácia pre všetky nové integrácie. Stará — len pre spätnú kompatibilitu.

Ot.: Stránka Vývojár sa nezobrazuje — prečo?
Stránka je dostupná len pre Ownera.

Ot.: Existujú obmedzenia na počet požiadaviek na API?
Áno. Podrobnosti — v dokumentácii API.

Ot.: Kde nájsť API kľúč na prácu s smenaon API?
Integrations → Vývojár → Žiadosti → vytvorte aplikáciu → v nastaveniach získate API credentials.

Ot.: Podporuje smenaon OAuth 2.0?
Áno. Autorizácia cez OAuth sa používa na pripojenie aplikácií tretích strán. Podrobnosti v dokumentácii API.

Ot.: Dá sa testovať API bez vytvorenia aplikácie?
Áno — použite nástroje typu Postman s vašimi prihlasovacími údajmi. Pre produkciu sa odporúča zaregistrovať aplikáciu.

Ot.: Aký je rozdiel medzi New a Staré dokumenty?
Nová dokumentácia — aktuálna (odporúčaná pre všetky nové integrácie). Staré dokumenty — pre spätnú kompatibilitu s existujúcimi integráciami.

Ot.: Dajú sa získať údaje výkazov cez API?
Áno. API Shifton poskytuje prístup k údajom rozvrhov, zamestnancov a iným zdrojom. Podrobnosti v dokumentácii.

Ot.: Podporujú Webhooky všetky typy udalostí smenaon?
Nie, len určité. Zoznam podporovaných udalostí — v sekcii Developer → Webhooks dokumentácie.

Ot.: Sú potrebné technické znalosti na prácu s API?
Áno. Na prácu s REST API a vytváranie integrácií cez Applications sú potrebné základné vývojárske zručnosti.

Ot.: Je API pNeskoroné alebo je súčasťou predplatného?
API je dostupné v rámci predplatného bez ďalších poplatkov. Obmedzenia závisia od tarifného plánu.

Ot.: Ako získať podporu pri problémoch s integráciou cez API?
Obráťte sa na podporu Shifton s popisom požiadavky, odpovede a kódu chyby. Taktiež si preštudujte dokumentáciu na stránke Developer.

Ot.: Aká je základná URL pre API smenaon?
Základná URL je api2.shifton.com. Podrobnosti a príklady požiadaviek sú dostupné v Nová dokumentácia.

Ot.: Podporuje API stránkovanie pri požiadavkách na veľké zoznamy?
Áno. Podrobnosti implementácie stránkovania sú popísané v dokumentácii API.

Ot.: Dá sa cez API vytvárať a mazať zmeny?
Áno. API poskytuje plný CRUD prístup k zmenám, zamestnancom, rozvrhom a iným zdrojom.

Ot.: Existuje sandbox prostredie na testovanie API?
Špeciálne sandbox prostredie neexistuje. Odporúča sa vytvoriť testovaciu spoločnosť v Shifton na bezpečné testovanie.

Ot.: Aké Vytvoriťáty údajov podporuje API?
API používa formát JSON pre požiadavky a odpovede.