API-avaimet ja API
Anna toisen järjestelmän lukea ja kirjoittaa IDup-tietojasi avaimen avulla, jonka voit uusia tai poistaa, ja löydä API-opas.
API-avain on salasana, joka kuuluu ohjelmalle henkilön sijasta. Kohtele sitä samalla tavalla: luo yksi per järjestelmä ja korvaa se, kun järjestelmä muuttuu.
Luo avain
- Avoin API → API-hallinta ja paina Uusi avain.
- Anna sille nimi, joka kertoo, mikä järjestelmä sitä käyttää.
- Valitse sen Oikeudet: Täysi pääsy, tai vain ne alueet, joita järjestelmä tarvitsee. Useimmat alueet erottavat lukemisen, luomisen ja muuttamisen.
- Valitse viimeinen voimassaolopäivä tai ei mitään.
- Käytä Näytä ja Kopioi avainkortilla luovuttaaksenne avaimen kutsuvalle järjestelmälle. Järjestelmä lähettää sen authtoken otsikko.
Jokainen avainkortti näyttää oikeudet, luontipäivän, Viimeksi käytetty ja merkki, kuten ”aktiivinen” tai ”vanhenee 5 päivän kuluttua”.
Uusi avain ennen sen vanhenemista
Neljätoista päivää ennen avaimen vanhenemista saat ilmoituksen kelloon. Paina Uusi avainkortilla ja valitse uusi vanhenemispäivä. IDup luo uuden avaimen samoilla oikeuksilla. Kopioikaa se heti, sillä tämä näyttö ilmestyy vain kerran. Vanha avain pysyy voimassa oman vanhenemisensa asti, joten voitte vaihtaa järjestelmän ilman katkosta.
Alueet, joihin pääsette
API kattaa asiakastietosi ja, suunnitelmastasi riippuen, kiinteistöt ja vuokrat, hakuprofiilit, verotiedostot, tilitoimistotiedostot, kirjanpidon, palkkalaskelmat ja kuittien skannauksen. AI Studio ja postilaatikko ovat omilla alueillaan. API-opas listaa vain ne alueet, jotka suunnitelmasi sisältää.
API-opas
Avaa Dokumentaatio välilehti API-hallintasivulla, tai API → API-opas. Jokainen alue näyttää kenttänsä, esimerkkipyynnöt, joita voit kopioida, esimerkkivastaukset ja virhekoodit.
Webhooks ja muut rajapinnat
- Se Webhooks välilehti lähettää tapahtumat järjestelmääsi niiden tapahtuessa — katso Lähetä tapahtumat omaan järjestelmääsi webhookien avulla.
- Jos Asiakas-API on kytketty päälle, a Asiakkaat API-asetukset välilehti avaa sen asetukset, esimerkiksi saavatko asiakkaat rekisteröityä API:n kautta.
- Automaatio / työnkulut → Tekninen rajapinta antaa tunnuksen GraphQL-rajapinnalle.
- AI Studio → Henkilökohtaiset API-avaimet on erillinen avainjoukko.
Turvallisuuden säilyttäminen
- Yksi avain per järjestelmä, ei koskaan jaettua.
- Anna avaimelle vain järjestelmän tarvitsemat oikeudet.
- Aseta vanhentumispäivä ja uusi aikataulun mukaisesti.
- Poista avain heti, kun joku, joka tiesi sen, lähtee tai järjestelmä sammutetaan.
Mikään ei seurata — painikkeet vain avaavat viestin, jotta voitte kertoa meille, mitä puuttui.
