API‑avaimet | Procurize.AI#
Luo, hallitse ja käytä API-avaimia turvalliseen ohjelmalliseen pääsyyn Procurize.AI-työtilaan.
Koskee: Procurize.AI Hallintapaneeli → Asetukset → Avainkoodit
Saatavilla: Business- ja Enterprise‑tilauksissa
Vaadittu rooli: Admin tai ylläpitäjä
Yleiskatsaus#
API‑avaimet mahdollistavat turvallisen, ohjelmallisen pääsyn Procurize.AI‑alustalle. Voit käyttää avaimia integroidaksesi Procurize.AI:n sisäisiin järjestelmiisi, automatisoidaksesi työnkulkuja tai rakentaaksesi omia sovelluksia alustan päälle.
Keskeiset ominaisuudet:
- Avaimet perivät kaikki oikeudet käyttäjältä, joka on ne luonut
- Avaimet ovat organisaatio‑tasoisia – ei tarvitse määrittää
org‑parametria API‑kutsuissa - Voit luoda rajoittamattoman määrän avaimia
- Avaimilla voi olla vanhenemispäivä tai ne voidaan asettaa pysyvästi voimassa oleviksi
- Avaimia voi deaktivoida ja myöhemmin aktivoida uudelleen tarvittaessa
🔒 Turvallisuusohje: Procurize.AI ei tallenna avaimen arvoa – vain sen hajautusarvoa. Sinun tulee kopioida ja tallentaa avain välittömästi luomisen jälkeen. Sitä ei näytetä uudelleen.
Pääsy avainten hallintapaneeliin#
- Siirry Hallintapaneeli → Asetukset → Avaimet -välilehdelle.
- Avainten hallintapaneeli näyttää henkilökohtaiset avaimet, jotka liittyvät nykyiseen organisaatioon.
Vaadittu lupa: Vain käyttäjät, joilla on Admin‑ tai Ylläpitäjä‑roolit, voivat käyttää tätä paneelia. Tarkat roolimääritelmät löydät Käyttöoikeuksien yleiskatsaus -sivulta.
Uuden avaimen luominen#
Syötä Nimi, jolla tunnistat avaimen tarkoituksen.
Valitse vanhenemisaika:
- 1 kuukausi
- 3 kuukautta
- 1 vuosi
- Ei vanhenemista (rajoittamaton voimassaolo)
Napsauta “Luo”.
Tärkeää – Kopioi avain heti#
Luomisen jälkeen avaimen arvo näytetään kerran – kopioi se ja säilytä turvallisesti (esim. salasanojen hallinnassa tai ympäristömuuttujassa).
⚠️ Et voi enää koskaan nähdä avaimen arvoa uudelleen. Procurize.AI tallentaa vain turvahajautuksen tarkistusta varten. Jos menetät avaimen, sinun täytyy peruuttaa se ja luoda uusi.
Olemassa olevien avainten hallinta#
Avainten paneeli näyttää listan kaikista luoduista avaimista, joihin sisältyy:
- Nimi
- Loppuliite
- Luontipäivä
- Päättymispäivä (tai “-”)
- Tila: Aktiivinen tai Passiivinen
Avaimen deaktivoiminen / reaktivoiminen#
- Deaktivoi – poistaa avaimen väliaikaisesti käytöstä. Voit aktivoida sen uudelleen myöhemmin tarpeen mukaan.
- Aktivoi uudelleen – palauttaa aiemmin deaktivoidun avaimen takaisin aktiiviseksi.
💡 Deaktivointi on hyödyllistä, kun haluat tilapäisesti keskeyttää integraatiot poistamatta avainta.
Avaimen peruuttaminen#
- Peruuta – poistaa avaimen pysyvästi. Tätä toimenpidettä ei voi peruuttaa.
- Jos menetät avaimen, peruuta se välittömästi ja luo uusi.
API-avaimen käyttö#
Perus-URL ja todennus#
| Parametri | Arvo |
|---|---|
| Perus‑URL | https://api.procurize.com |
| Tunnistusmenetelmä | API‑avain otsakkeessa |
| Otsake | X-API-Key: <YOUR_API_TOKEN> |
Esimerkkipyyntö (cURL)#
curl -X GET "https://api.procurize.com/v1/documents" \
-H "X-API-Key: YOUR_API_TOKEN"
🧠 Organisaatio‑ID:tä ei tarvita – avain on sidottu organisaatioosi, joten API selvittää kontekstin automaattisesti.
Tärkeitä turvallisuus‑ ja käyttöohjeita#
| Sääntö | Selitys |
|---|---|
| Avaimen oikeudet | Avaimella on täsmälleen samat oikeudet kuin käyttäjällä, joka sen loi. Jos käyttäjän rooli muuttuu, avaimen oikeudet päivittyvät automaattisesti. |
| Organisaatiosidonta | Avaimet ovat sidottuja niiden luojan organisaatioon. Et voi käyttää avainta useiden organisaatioiden välillä. |
| Avaimen näkyvyys | Avaimen arvo näytetään vain kerran. Tallenna se heti. Procurize.AI tallentaa vain hajautusarvon. |
| Vanhenneet avaimet | Vanhenneet avaimet deaktivoidaan automaattisesti eikä niitä voi käyttää. Luo uusi avain tarvittaessa. |
Vianmääritys#
| Ongelma | Ratkaisu |
|---|---|
| “Virheellinen API-avain” -virhe | Tarkista, että avain on kopioitu oikein (ei ylimääräisiä välilyöntejä). Varmista, että avain on edelleen aktiivinen eikä vanhentunut. |
| Avaimen toimimattomuus roolin muutoksen jälkeen | Avaimen oikeudet päivittyvät vastaamaan käyttäjän nykyistä roolia. Jos käyttäjä menetti oikeuksia, myös avain menettää ne. |
| Kadonnut avain | Peruuta kadonnut avain ja luo uusi. |
| Ratelimiting | API‑rajoitukset perustuvat tilaasi. Tarkista X-RateLimit-* -otsakkeet vastauksessa. |
Aiheeseen liittyvät artikkelit#
- Käyttöoikeuksien yleiskatsaus – tarkat roolimääritelmät
- Hinnoittelusuunnitelmat – mitkä suunnitelmat sisältävät API‑pääsyn
- REST API -viittaus – tarkka endpoint-dokumentaatio