API prieigos raktai | Procurize.AI#

Generuokite, tvarkykite ir naudokite API prieigos raktus saugiam programiniam prieigai prie jūsų Procurize.AI darbo erdvės.

Taikoma: Procurize.AI skydelis → Nustatymai → Raktai
Prieinama: Verslo ir įmonės planuose
Reikalinga rolė: Saugumo vadovas, Redaktorius, Administratorius arba Prižiūrėtojas

Apžvalga#

API raktai suteikia saugią, programinę prieigą prie Procurize.AI platformos. Galite naudoti raktus integruoti Procurize.AI su savo vidinėmis sistemomis, automatizuoti darbo procesus arba kurti pasirinktines programas ant platformos.

Pagrindinės savybės:

Raktai paveldi visas teises vartotojo, sukūrusio juos
Raktai yra organizacijos apriboti – nereikia nurodyti org API užklausose
Gali būti generuojama neribota raktų skaičius
Raktai gali turėti galiojimo datas arba būti nustatyti kaip nesibaigiantys
Raktus galima deaktyvuoti ir vėliau reaktyvuoti, kai reikia

🔒 Saugumo pastaba: Procurize.AI nesaugo prieigos rakto vertės – tik jo maišą. Turite iš karto po generavimo nukopijuoti ir saugiai išsaugoti raktą. Jis nebus rodomas vėl.

Prieiga prie prieigos raktų valdymo skydelio#

Eikite į Skydelį → API prieigos raktų puslapį.
Raktų valdymo skydelyje matysite savo asmeninius raktus, susietus su dabartine organizacija.

API raktų puslapis

Reikalinga teisė: Tik vartotojai su Saugumo vadovo, Redaktoriaus, Administratoriaus arba Prižiūrėtojo rolėmis gali pasiekti šį skydelį. Išsamias rolės apibrėžimus rasite Teisių apžvalgoje .

Naujo rakto generavimas#

Įveskite Pavadinimą, kad identifikuotumėte rakto paskirtį.
Pasirinkite galiojimo periodą:
- 1 mėnuo
- 3 mėnesiai
- 1 metai
- Be galiojimo (neribotas galiojimas)
Spustelėkite „Generuoti“.

Svarbu – iš karto nukopijuokite raktą#

Po generavimo rakto vertė rodomi vieną kartą – nukopijuokite ją ir saugiai išsaugokite (pvz., slaptažodžių tvarkytuve arba aplinkos kintamajame).

Naujas API raktas

⚠️ Jūs nebegalėsite vėl peržiūrėti rakto vertės. Procurize.AI saugo tik saugų maišą patikrinimui. Jei prarandate raktą, turite jį atšaukti ir generuoti naują.

Esamų raktų valdymas#

Raktų skydelyje rodomas visų sukurtų raktų sąrašas su jų:

Pavadinimas
Galūnė
Sukūrimo data
Galiojimo data (arba „-“)
Būsena: Aktyvus arba Neaktyvus

Deaktyvavimas / Reactyvavimas#

Deaktyvuoti – laikinai išjungia raktą. Vėliau, kai reikia, galite jį reaktyvuoti.
Reaktyvuoti – atkuria anksčiau deaktyvuotą raktą į aktyvią būseną.

💡 Deaktyvavimas yra naudingas laikinai sustabdyti integracijas neištrinant rakto.

Rakto atšaukimas#

Atšaukti – visam laikui ištrina raktą. Šio veiksmo atšaukti neįmanoma.
Jei prarandate raktą, nedelsiant jį atšaukite ir sukurkite naują.

API rakto naudojimas#

Bazinis URL ir autentifikacija#

Parametras	Vertė
Bazinis URL	`https://api.procurize.com`
Autentifikacijos metodas	API raktas per antraštę
Antraštė	`X-API-Key: <YOUR_API_TOKEN>`

Pavyzdinė užklausa (cURL)#

curl -X GET "https://api.procurize.com/v1/documents" \
  -H "X-API-Key: YOUR_API_TOKEN"

🧠 Organizacijos ID nereikia – raktas yra susietas su jūsų organizacija, todėl API automatiškai nustato kontekstą.

Svarbios saugumo ir naudojimo taisyklės#

Taisyklė	Paaiškinimas
Raktų teisės	Raktas turi lygiai tas pačias teises kaip vartotojas, sukūręs jį. Jei vartotojo rolė pasikeičia, atnaujinamos ir rakto teisės.
Organizacijos susiejimas	Raktai yra susieti su kūrėjo organizacija. Negalima naudoti rakto kelioms organizacijoms.
Rakto matomumas	Rakto vertė rodoma tik vieną kartą. Iš karto ją išsaugokite. Procurize.AI saugo tik maišą.
Pasibaigę raktai	Pasibaigę raktai automatiškai deaktyvuojami ir negali būti naudojami. Jei reikia, sukurkite naują raktą.

Trikčių šalinimas#

Problema	Sprendimas
„Neteisingas API raktas“ klaida	Patikrinkite, ar raktas teisingai nukopijuotas (be papildomų tarpų). Įsitikinkite, kad raktas vis dar aktyvus ir nepasibaigęs.
Raktas neveikia po rolės pakeitimo	Rakto teisės atnaujinamos pagal vartotojo dabartinę rolę. Jei vartotojas praranda teises, raktas taip pat jas praranda.
Prarastas raktas	Atšaukite prarastą raktą ir generuokite naują.
Ribojimas (Rate limiting)	API greičio apribojimai taikomi pagal jūsų planą. Patikrinkite `X-RateLimit-*` antraštes atsakyme.

Susijusios temos#

Teisių apžvalga – išsamios rolės apibrėžtys
Kainodaros planai – kurie planai apima API prieigą
REST API nuoroda – išsamus galinių taškų dokumentavimas