Yleiskatsaus kehittäjille

Developer-sivu tarjoaa pääsyn Shiftonin API-dokumentaatioon ja työkaluihin mukautettujen integraatioiden luomiseen.

Vaiheittaiset ohjeet

Developer-sivulle pääsy

Napsauta vasemmassa sivupalkissa Integraatiot.

Siirry Kehittäjä-sivulle.

Yläosassa on kolme välilehteä: Yleiskatsaus, Webhookit ja Hakemukset.

Overview-välilehden käyttö

Linkki	Kuvaus
Uusi dokumentaatio	Ajantasainen API-dokumentaatio
Vanha dokumentaatio	Vanhentunut dokumentaatio olemassa olevia integraatioita varten

Napsauta haluamaasi linkkiä — dokumentaatio avautuu uudessa välilehdessä.

Muut Developer-välilehdet

Webhookit

mdash; määritä päätepisteet reaaliaikaisia tapahtumailmoituksia varten.

Hakemukset

mdash; luo ja hallitse mukautettuja sovelluksia.

Aiheeseen liittyvät artikkelit

Usein kysytyt kysymykset

K: Kumpaa dokumentaatiota käyttää — uutta vai vanhaa?
Käytä Uusi dokumentaatio kaikkiin uusiin integraatioihin. Vanha on vain taaksepäin yhteensopivuutta varten.

K: Kehittäjä-sivu ei näy — miksi?
Sivu on käytettävissä vain omistajalle ja ylläpitäjälle.

K: Onko API-pyyntöjen määrää rajoitettu?
Kyllä. Tarkemmat tiedot API-dokumentaatiossa.

K: Mistä löytyy API-avain vuoroon API:n käyttöä varten?
Integrations → Kehittäjä → Hakemukset → luo sovellus → asetuksista saat API-tunnistetiedot.

K: Tukeeko vuoroon OAuth 2.0:aa?
Kyllä. OAuth-valtuutusta käytetään kolmannen osapuolen sovellusten yhdistämiseen. Tarkemmat tiedot API-dokumentaatiossa.

K: Voiko API:a testata luomatta sovellusta?
Kyllä — käytä Postman-tyyppisiä työkaluja tunnistetiedoillasi. Tuotantokäyttöön suositellaan sovelluksen rekisteröintiä.

K: Mikä ero on New ja Vanha dokumentaatio välillä?
Uusi dokumentaatio — ajantasainen (suositellaan kaikkiin uusiin integraatioihin). Vanha dokumentaatio — taaksepäin yhteensopivuutta varten olemassa olevien integraatioiden kanssa.

K: Voiko raporttitietoja hakea API:n kautta?
Kyllä. Shiftonin API tarjoaa pääsyn työvuorolistoihin, työntekijätietoihin ja muihin resursseihin. Tarkemmat tiedot dokumentaatiossa.

K: Tukevatko webhookit kaikkia vuoroon-tapahtumatyyppejä?
Ei, vain tiettyjä. Tuettujen tapahtumien luettelo Developer → Webhooks -dokumentaatiossa.

K: Vaaditaanko teknistä osaamista API:n käyttöön?
Kyllä. REST API:n ja integraatioiden luomiseen Applications-osion kautta tarvitaan perustason kehittäjätaidot.

K: Onko API maksullinen vai sisältyykö se tilaukseen?
API on käytettävissä tilauksen puitteissa ilman lisämaksua. Rajoitukset riippuvat tilaussuunnitelmasta.

K: Miten saan tukea API-integraatio-ongelmissa?
Ota yhteyttä Shiftonin tukeen pyynnön, vastauksen ja virhekoodin kuvauksella. Tutustu myös Developer → Overview -sivun dokumentaatioon.

K: Mikä Vuorossaon API:n perus-URL?
Perus-URL on api2.shifton.com. Tarkemmat tiedot ja esimerkkipyynnöt Uusi dokumentaatio -osiossa.

K: Tukeeko API sivutusta suurten luetteloiden kyselyssä?
Kyllä. Sivutuksen toteutuksen tiedot löytyvät API-dokumentaatiosta.

K: Voiko API:n kautta luoda ja poistaa vuoroja?
Kyllä. API tarjoaa täyden CRUD-pääsyn vuoroihin, työntekijöihin, työvuorolistoihin ja muihin resursseihin.

K: Onko sandbox-ympäristöä API:n testaamiseen?
Erillistä sandbox-ympäristöä ei ole. Suositellaan luomaan testiyritys Shiftoniin turvallista testausta varten.

K: Mitä tietomuotoja API tukee?
API käyttää JSON-muotoa pyynnöissä ja vastauksissa.