API-avainten luominen ja hallinta
Avaimen luominen julkiseen API:in, sen käyttöoikeuksien ja voimassaolon valinta, rajaaminen IP-osoitteen mukaan ja peruminen.
API-avaimella työkalusi voivat kutsua Upsellrin julkista API:a organisaatiosi puolesta. Pääsy API:in on varattu Enterprise-paketille.
Mistä avaimet löytyvät
Avaa tilivalikko ja sitten Manage ja API & webhooks. Muussa kuin Enterprise-paketissa osiossa näkyy ”Included in the Enterprise plan” ja painike paketin vaihtamiseen.
Avaimen luominen
- Napsauta Create API Key.
- Anna sille nimi (Name), joka kertoo sen käyttötarkoituksen, esimerkiksi sitä käyttävän työkalun nimi.
- Valitse käyttöoikeuksien esiasetus (Scope preset):
- Read only: kanavien, tuotteiden, lähteiden, työnkulkujen, jäsenten ja organisaation lukeminen.
- Read & Write: kaikki paitsi työnkulkujen käynnistäminen.
- Full access: kaikki käyttöoikeudet, myös työnkulkujen käynnistäminen.
- Custom: valitse halutut käyttöoikeudet yksitellen.
- Valitse voimassaolo (Expiration): 7 päivää, 30 päivää, 90 päivää, 1 vuosi, 3 vuotta, No expiration tai mukautettu kesto yhdestä päivästä 1 095 päivään.
- Täytä tarvittaessa kentät Allowed IPs ja Allowed User-Agents pilkuilla erotettuina.
- Napsauta Create Key.
Avain näytetään vain kerran. Kopioi se ja säilytä se turvallisessa paikassa ennen ikkunan sulkemista.
Käytettävissä olevat käyttöoikeudet
| Resurssi | Käyttöoikeudet |
|---|---|
| Kanavat | Luominen, lukeminen, muokkaaminen, poistaminen |
| Tuotteet | Luominen, lukeminen, muokkaaminen, poistaminen |
| Lähteet | Lukeminen, lähdetiedostojen tallentaminen |
| Työnkulut | Lukeminen, käynnistäminen |
| Organisaatio | Organisaation lukeminen, jäsenten lukeminen |
Avaimen peruminen
Napsauta luettelossa avaimen vieressä Revoke. Kaikki sitä käyttävät integraatiot lakkaavat toimimasta heti. Tätä toimenpidettä ei voi perua.
Hyvä tietää
- Vain omistajat ja ylläpitäjät luovat ja peruvat avaimia. Jäsenet näkevät ne vain luku -tilassa.
- Luettelo näyttää kunkin avaimen käyttöoikeudet, vanhenemispäivän ja viimeisimmän käytön (Last used): koskaan käyttämätön avain on usein peruttava avain.
- Työnkulun käynnistäminen voi koskea monia tuotteita ja kuluttaa paljon krediittejä. Anna käynnistysoikeus vain integraatioille, jotka tarvitsevat sitä.
- Luo yksi avain integraatiota kohden vain tarvittavilla käyttöoikeuksilla.
- Kadonnutta avainta ei voi näyttää uudelleen: peru se ja luo uusi.