API raktai | Procurize.AI#

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

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

Apžvalga#

API raktai leidžia saugią programinę prieigą prie Procurize.AI platformos. Galite naudoti raktus integruoti Procurize.AI su jūsų vidinėmis sistemomis, automatizuoti darbo procesus arba kurti papildomas programas ant platformos.

Pagrindinės savybės:

Raktai paveldi visus sukūrėjo naudotojo leidimus
Raktai yra organizacijos apriboti – nereikia nurodyti org API kvietimuose
Galima generuoti neribotą raktų skaičių
Raktai gali turėti galiojimo datas arba būti su neribotu galiojimo laiku
Raktai gali būti deaktyvuoti ir vėliau reaktyvuoti, kai to reikia

🔒 Saugumo pastaba: Procurize.AI neįrašo raktų reikšmių – tik jų hashus. Turite iškart nukopijuoti ir išsaugoti raktą po generavimo. Jis nebus rodomas vėl.

Raktų valdymo skydelio pasiekimas#

Eikite į Skydelį → Nustatymai → Raktai skirtuką.
Raktų valdymo skydelyje matysite savo asmeninius raktus, susietus su dabartine organizacija.

API raktų skydelis

Reikalingas leidimas: Tik naudotojai su Administratorius arba Prižiūrėtojas rolėmis gali pasiekti šį skydelį. Išsamias rolės apibrėžtis rasite Leidimų apžvalgoje .

Naujo rakto generavimas#

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

Svarbu – iš karto nukopijuokite raktą#

Po generavimo raktų reikšmė rodomi vieną kartą – ją nukopijuokite ir saugiai išsaugokite (pvz., slaptažodžių tvarkytuvėje arba aplinkos kintamajame).

Naujas API raktas

⚠️ Jūs nebegalėsite peržiūrėti raktų reikšmės. Procurize.AI saugo tik saugų hashą patikrinimui. Jei prarasite raktą, turite jį atšaukti ir generuoti naują.

Esamų raktų valdymas#

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

Pavadinimu
Galūne
Sukūrimo data
Galiojimo data (arba „-“)
Būseną: Aktyvus arba Neaktyvus

Raktų deaktyvavimas / reaktyvavimas#

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

💡 Deaktyvavimas naudingas laikinam integracijų sustabdymui be rakto ištrynimo.

Raktų atšaukimas#

Atšaukti – negrįžtamai ištrina raktą. Šio veiksmo atšaukti negalima.
Jei prarandate raktą, nedelsiant jį atšaukite ir sukurkite naują.

API rakto naudojimas#

Pagrindinis URL ir autentifikacija#

Parametras	Reikšmė
Pagrindinis URL	`https://api.procurize.com`
Autentifikacijos metodas	API raktas per antraštę
Antraštė	`X-API-Key: <JŪSŲ_API_RAKTAS>`

Pavyzdinis užklausimas (cURL)#

curl -X GET "https://api.procurize.com/v1/documents" \
  -H "X-API-Key: JŪSŲ_API_RAKTAS"

🧠 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
Rakto leidimai	Raktas turi lygiai tas pačias teises kaip naudotojas, kuris jį sukūrė. Jei naudotojo rolė pasikeičia, atnaujinami ir rakto leidimai.
Organizacijos susiejimas	Raktai yra susieti su kūrėjo organizacija. Negalima naudoti rakto keliose organizacijose.
Rakto matomumas	Rakto reikšmė rodoma tik vieną kartą. Išsaugokite ją iš karto. Procurize.AI saugo tik hashą.
Pasibaigę raktai	Pasibaigę raktai automatiškai deaktyvuojami ir negali būti naudojami. Jei reikia, sukurkite naują raktą.

Trikčių šalinimas#

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

Susijusios temos#

Leidimų apžvalga – išsamios rolės apibrėžtys
Kainodaros planai – kurie planai apima API prieigą
REST API dokumentacija – išsamus galinių taškų aprašymas