API‑tunnisteet | Procurize.AI#
Luo, hallitse ja käytä API‑tunnisteita turvalliseen ohjelmalliseen pääsyyn Procurize.AI-työtilaan.
Koskee: Procurize.AI Hallintapaneeli → Asetukset → Tunnisteet
Saatavilla: Business‑ ja Enterprise‑suunnitelmissa
Vaadittu rooli: Turvallisuusjohtaja, Editori, Ylläpitäjä tai Maintainer
Yleiskatsaus#
API‑tunnisteet mahdollistavat turvallisen ohjelmallisen pääsyn Procurize.AI-alustalle. Voit käyttää tunnisteita integroidaksesi Procurize.AI:n sisäisiin järjestelmiisi, automatisoidaksesi työnkulkuja tai rakentaaksesi mukautettuja sovelluksia alustan päälle.
Keskeiset ominaisuudet:
- Tunnisteet perivät kaikki oikeudet käyttäjältä, joka ne loi
- Tunnisteet ovat organisaatio‑tasoisia – ei tarvitse määrittää
org-parametria API‑kutsuissa - Rajoittamaton määrä tunnisteita voidaan luoda
- Tunnisteilla voi olla vanhentumispäivä tai ne voidaan asettaa pysyvästi voimassa oleviksi
- Tunnisteita voidaan deaktivoida ja myöhemmin aktivoida uudelleen tarpeen mukaan
🔒 Turvallisuushuomautus: Procurize.AI ei tallenna tunnisteen arvoa – ainoastaan sen tiivistettä. Sinun on kopioitava ja tallennettava tunniste heti luomisen jälkeen. Sitä ei näytetä uudelleen.
Pääsy Tunnisteiden Hallintapaneeliin#
- Siirry Hallintapaneeliin → API‑tunnisteet -sivulle.
- Tunnisteiden hallintapaneeli näyttää henkilökohtaiset tunnisteesi, jotka liittyvät nykyiseen organisaatioon.
Tarvittava oikeus: Vain käyttäjät, joilla on roolit Security Manager, Editor, Admin tai Maintainer, voivat käyttää tätä paneelia. Tarkempia roolimäärittelyjä löydät Oikeuksien yleiskatsauksesta .
Uuden Tunnisteen Luominen#
Syötä Nimi tunnisteen tarkoituksen tunnistamiseksi.
Valitse vanhenemisjakso:
- 1 kuukausi
- 3 kuukautta
- 1 vuosi
- Ei vanhentumista (rajoittamaton voimassaolo)
Napsauta “Luo”.
Tärkeää – Kopioi Tunniste Välittömästi#
Luomisen jälkeen tunnisteen arvo näytetään kerran – kopioi se ja säilytä turvallisesti (esim. salasanojen hallintatyökalussa tai ympäristömuuttujassa).
⚠️ Et voi nähdä tunnisteen arvoa enää uudelleen. Procurize.AI tallentaa vain turvallisen tiivisteen tarkistusta varten. Jos menetät tunnisteen, sinun on peruutettava se ja luotava uusi.
Olemassa olevien Tunnisteiden Hallinta#
Tunnisteiden paneeli näyttää luotujen tunnisteiden luettelon, jossa on:
- Nimi
- Loppuliite
- Luontipäivä
- Vanhentumispäivä (tai “-”)
- Tila: Aktiivinen tai Ei‑aktiivinen
Tunnisteen Deaktivointi / Reactivointi#
- Deaktivoi – poistaa tunnisteen tilapäisesti käytöstä. Voit aktivoida sen uudelleen myöhemmin tarpeen mukaan.
- Aktivoi uudelleen – palauttaa aiemmin deaktivoidun tunnisteen aktiiviseksi.
💡 Deaktivointi on hyödyllistä, kun haluat tilapäisesti keskeyttää integraatiot poistamatta tunnistetta.
Tunnisteen Peruutus#
- Peruuta – poistaa tunnisteen pysyvästi. Tätä toimintoa ei voi peruuttaa.
- Jos menetät tunnisteen, peruuta se välittömästi ja luo uusi.
API‑tunnisteen Käyttö#
Perus-URL ja Tunnistautuminen#
| Parametri | Arvo |
|---|---|
| Base URL | https://api.procurize.com |
| Authentication method | API‑avain otsikon kautta |
| Header | 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 – tunniste on sidottu organisaatioosi, joten API ratkaisee kontekstin automaattisesti.
Tärkeitä Turvallisuus‑ ja Käyttösääntöjä#
| Sääntö | Selitys |
|---|---|
| Tunnisteen oikeudet | Tunnisteella on täsmälleen samat oikeudet kuin käyttäjällä, joka sen loi. Jos käyttäjän rooli muuttuu, tunnisteen oikeudet päivittyvät vastaavasti. |
| Organisaatiosidonta | Tunnisteet ovat sidottuja luojan organisaatioon. Et voi käyttää tunnistetta useassa organisaatiossa. |
| Tunnisteen näkyvyys | Tunnisteen arvo näytetään vain kerran. Tallenna se heti. Procurize.AI tallentaa vain tiivisteen. |
| Vanhentuneet tunnisteet | Vanhentuneet tunnisteet deaktivoidaan automaattisesti, eikä niitä voi käyttää. Luo tarvittaessa uusi tunniste. |
Vianmääritys#
| Ongelma | Ratkaisu |
|---|---|
| “Virheellinen API-avain” -virhe | Varmista, että tunniste on kopioitu oikein (ei ylimääräisiä välilyöntejä). Tarkista, että tunniste on edelleen aktiivinen eikä vanhentunut. |
| Tunniste ei toimi roolin muutoksen jälkeen | Tunnisteen oikeudet päivittyvät vastaamaan käyttäjän nykyistä roolia. Jos käyttäjä menetti oikeuksia, myös tunniste menettää ne. |
| Kadonnut tunniste | Peruuta kadonnut tunniste ja luo uusi. |
| Nopeusrajoitus | API:n nopeusrajoitukset perustuvat suunnitelmaasi. Tarkista X-RateLimit-* -otsikot vastauksessa. |
Aiheeseen Liittyvät#
- Oikeuksien yleiskatsaus – tarkat roolimäärittelyt
- Hinnoittelusuunnitelmat – mitkä suunnitelmat sisältävät API‑pääsyn
- REST API -viite – yksityiskohtainen päätepisteiden dokumentaatio