Plugchoicen REST-rajapinnalla voit rakentaa oman tuotteesi alustan päälle: lukea latausasemia, lataustapahtumia ja mittarilukemia, käynnistää ja lopettaa latauksen, hallita kortteja, sijainteja ja tehonhallintaa ja paljon muuta. Tämä sivu on kumppaneille tarkoitettu lyhyt versio; täydellinen tekninen dokumentaatio on osoitteessa developer.plugchoice.com.
Mistä dokumentaatio löytyy
developer.plugchoice.com: täydellinen rajapintaviite sekä oppaat tunnistautumisesta, virheistä, sivutuksesta ja kutsurajoituksista.
Rakennatko tekoälyavustajan kanssa? Anna sille developer.plugchoice.com/llms.txt (hakemisto) tai llms-full.txt (koko dokumentaatio yhdessä tiedostossa). Tekoälytyökalusi osaa sen jälkeen vastata rajapintaa koskeviin kysymyksiin ja kirjoittaa integraation puolestasi.
Kaksi tapaa tunnistautua
Henkilökohtainen käyttöoikeustunnus (personal access token): nopein tapa aloittaa, oman tilisi omaan käyttöön, kuten skripteihin, testaukseen, kodin automaatioon tai omaan kojelautaan. Luo tunnus verkkoportaalissa kohdassa Asetukset > Oma tili > API-tokenit valinnalla Luo API-token. Tunnuksen käyttö muille tarkoitetussa tuotteessa tai palvelussa tai muiden tilien tietojen hakemiseen edellyttää API Professionalia.
OAuth 2.0 (API Professional): asiakkaidesi käyttämiin tuotteisiin. Sovelluksesi saa oman pääsyn kunkin asiakkaan tietoihin tämän luvalla ja hänen hyväksymiensä käyttöoikeusalueiden (scopes) rajoissa, ilman että kukaan jakaa salasanoja tai tunnuksia. API Professional perustuu erilliseen sopimukseen käyttöoikeusalueista, kutsurajoista ja maksuista.
Miltä OAuth näyttää asiakkaallesi
Sovelluksessasi asiakas napsauttaa esimerkiksi Yhdistä Plugchoice.
Asiakas päätyy Plugchoicen kirjautumisnäkymään ja kirjautuu omalla tilillään, myös Googlella tai Applella.
Plugchoice näyttää, mitä pääsyä sovelluksesi pyytää, ja asiakas hyväksyy sen valinnalla Valtuuta.
Asiakas ohjataan takaisin sovellukseesi, joka saa nyt omat tunnuksensa kyseiselle asiakkaalle.
Kukaan ei kopioi tunnuksia eikä jaa salasanoja. Asiakas voi perua pääsyn milloin tahansa verkkoportaalissa kohdassa Asetukset > Oma tili > Yhdistetyt sovellukset (Peru pääsy) ja yksittäisen latausaseman osalta sen kohdassa Asetukset > Sovellukset.
Asiakkaasi ja heidän tietonsa
Sovelluksesi käyttää asiakkaan tietoja vain tämän hyväksymien käyttöoikeusalueiden rajoissa ja omaan palveluusi kyseiselle asiakkaalle.
Omistajuuden siirtoja, käyttöoikeuksien myöntämistä ja muita suostumusvaiheita ei koskaan automatisoida: käyttäjä vahvistaa jokaisen itse.
Jokainen, joka saa Plugchoice-tilin sovelluksesi, Linkin tai rajapinnan kautta, on Plugchoicen asiakas ehtojemme mukaisesti, ellei allekirjoitettu sopimus anna asiakassuhdetta sinulle. Voimme tiedottaa näille asiakkaille itse ja näyttää heille Plugchoice-sovelluksen.
Kun asiakas peruu pääsyn tai poistaa tilinsä, sovelluksesi lopettaa komentojen lähettämisen hänen latausasemilleen, poistaa rajapinnan kautta saadut henkilötiedot viipymättä ja muut rajapintatiedot 30 päivän kuluessa.
Pääsyn saaminen
OAuth kuuluu API Professionaliin. Lähetä meille uudelleenohjaus-URL (osoite sovelluksessasi, johon asiakas palaa hyväksynnän jälkeen) viestimen tai kumppaniyhteyshenkilösi kautta. Kun sopimus on tehty, määritämme OAuth-asiakkaasi ja lähetämme sinulle tunnistetiedot.
Henkilökohtaiset käyttöoikeustunnukset eivät vaadi meiltä mitään määrityksiä: luo tunnus verkkoportaalissa ja aloita.