API lyklar

Kynning

API lyklar veita utanaðkomandi forritum aðgang að Manor API. Notaðu þá til að tengja utanaðkomandi hugbúnað, samstilla fjárhags- eða verkefnagögn, gera endurtekin verkefni sjálfvirk og byggja sérsmíðaðar samtengingar. Þar sem API lyklar veita forritunaraðgang að Manor stofunni þinni er mjög mikilvægt að stjórna þeim á öruggan hátt og stilla viðeigandi aðgangsheimildir.

Lykilreitir

Þegar þú skoðar eða stillir API lykla muntu sjá eftirfarandi reiti:

• Nafn: Lýsandi nafn fyrir API lykilinn (t.d. „BI Integration Key" eða „Bókhaldssamtenging"). Notaðu þetta til að bera kennsl á hvaða þjónustu er verið að tengja eða tilgang samtengingarinnar.
• Notandi: Kerfisnotandinn sem er tengdur þessum API lykli. API lykillinn erfir allar heimildir sem eru skráðar á þennan kerfisnotanda. Aðeins er hægt að gefa út API lykla fyrir kerfisnotendur — ekki fyrir venjulega notendur.
• Auðkenni (Lykill): Einstakt auðkenni sem birtist í listanum. Þetta hjálpar til við að para kerfisbeiðnir eða atvikaskrá (log) við ákveðinn lykil, án þess að afhjúpa leynilykilinn sjálfan.
• Rennur út: Valfrjáls lokadagsetning þegar API lykillinn rennur sjálfkrafa út. Eftir að hann er útrunninn geta utanaðkomandi forrit ekki lengur notað hann til auðkenningar.
• Lýsing: Valfrjáls athugasemd til að skrásetja vinnulag lykilsins, tengt umhverfi eða ábyrgðarteymi.
• Staða: Núverandi rekstrarstaða lykilsins — annaðhvort Virkur eða Afturkallaður [dagsetning].
• Stofnað: Dagsetningin þegar API lykillinn var myndaður.

Stofnun nýs API lykils

Mikilvægt: Lykillinn er aðeins sýnilegur einu sinni, strax eftir að hann er myndaður. Af öryggisástæðum verður ekki hægt að nálgast hann eftir það. Afritaðu og geymdu lykilinn í öruggum lykilorðastjóra eða leynigeymslu áður en þú lokar glugganum.

Fylgdu þessum skrefum til að stofna API lykil:

1. Farðu í Kerfisstjórn → API lyklar í hliðarvalmyndinni.

2. Smelltu á Stofna lykil hnappinn í hægra horninu uppi.

   

3. Sláðu inn lýsandi Nafn (nauðsynlegt).

4. Veldu kerfisnotanda úr fellilistanum fyrir Notanda (nauðsynlegt).

   Athugaðu: Ef enginn kerfisnotandi er til ennþá, farðu í Kerfisstjórn → Notendur og smelltu á Stofna kerfisnotanda fyrir samtengingu kerfa til að stofna einn. Kerfisnotendur taka ekki upp venjuleg notendaleyfi og kosta því ekkert aukalega.

5. Veldu valfrjálsa dagsetningu í Rennur út með því að nota dagsetningarvalann.

6. Sláðu inn valfrjálsa Lýsingu sem útskýrir í hvað lykillinn er notaður.

7. Smelltu á Vista.

8. Afritaðu myndaða lykilinn strax úr staðfestingarglugganum.

9. Smelltu á Afrita hnappinn, geymdu lykilinn á öruggum stað og lokaðu síðan glugganum.

Stjórnun API lykla

Þú getur vaktað, breytt og gert API lykla óvirka á yfirlitssíðunni fyrir API lykla.

Að finna API lykla

Sláðu inn nafn, kerfisnotanda eða auðkenni (lykil) í Hraðleit boxið fyrir ofan töfluna til að sía listann samstundis.

Breyta API lykli

1. Smelltu á línuna fyrir þann API lykil sem þú vilt uppfæra.
2. Í Breyta lykli glugganum geturðu breytt Nafni, Rennur út eða Lýsingu eftir þörfum.
3. Smelltu á Vista.

Afturkalla API lykil

Ef lykill hefur komist í rangar hendur, verið tekinn úr notkun eða er ekki lengur nauðsynlegur fyrir samtengingu skaltu afturkalla hann strax:

1. Smelltu á línuna með virka lyklinum til að opna Breyta lykli gluggann.
2. Smelltu á rauða Afturkalla lykil hnappinn neðst til vinstri.
3. Í staðfestingarglugganum, smelltu á Staðfesta.

Þegar lykill er afturkallaður hættir hann strax að taka við beiðnum og staðan breytist í Afturkallaður [dagsetning]. Ekki er hægt að endurvekja afturkallaða lykla.

Góðar venjur

• Lágmarksréttindi (Principle of least privilege): Þegar þú setur upp kerfisnotendur fyrir API lykla, skaltu aðeins gefa þau hlutverk og heimildir sem eru algjörlega nauðsynleg fyrir virkni samtengingarinnar.
• Aðskildir lyklar fyrir hverja þjónustu: Stofnaðu sérstakan API lykil og kerfisnotanda fyrir hvert tól eða þjónustu. Það auðveldar alla yfirferð og gerir þér kleift að afturkalla aðgang fyrir eitt tól án þess að hafa áhrif á önnur.
• Notaðu gildistíma (Rennur út): Settu upp dagsetningar þegar lyklar renna út, sérstaklega fyrir aðgang þriðja aðila eða prufutengingar, til að koma í veg fyrir að gleymdir lyklar séu opnir endalaust.
• Endurnýjaðu lykla reglulega: Búðu til nýja lykla öðru hvoru, uppfærðu utanaðkomandi þjónustur og afturkallaðu gömlu lyklana.
• Deildu aldrei lyklum í opnum texta: Geymdu myndaða lykla eingöngu í öruggum lykilorðageymslum eða stillingarskrám umhverfisins, en aldrei í útgáfustjórnunarkóða (version control) eða spjallkerfum teymisins.