FlytBaseFlytBase Documentation

Vylepšený prístup k API

Spravujte prihlasovacie údaje rozhrania API bezpečne pomocou vylepšeného prístupu API.

Pre-Flight Modules

Funkcia Enhanced API Access od FlytBase predstavuje robustnú metódu na správu poverení API, ktorá ponúka výrazné zlepšenie oproti tradičným vzorom prístupu. Táto funkcia je navrhnutá tak, aby poskytovala kontrolované prihlasovacie údaje pre každú integráciu, zaisťovala bezpečné ukladanie a používanie prístupových tokenov s krátkou životnosťou. Umožňuje tiež zakázať alebo vymazať prístup bez toho, aby to ovplyvnilo iné systémy, čím sa zjednodušuje správa a prevádzka je bezpečnejšia. Enhanced API Access rieši výzvy, ktoré predstavujú staršie modely prístupu, ktoré často sťažovali izoláciu poverení integráciou, presadzovanie kontrol životného cyklu a minimalizáciu vplyvu, keď je potrebná výmena prístupových materiálov. Tým, že každý kľúč API alebo tajomstvo klienta sú explicitné a sledovateľné, táto funkcia zvyšuje bezpečnosť a prevádzkovú efektivitu. Bezproblémovo zapadá do širšieho pracovného toku produktu FlytBase, najmä pre používateľov, ktorí spravujú viacero integrácií a vyžadujú bezpečný a spravovateľný spôsob spracovania poverení API. Kľúčovou výhodou Enhanced API Access je jeho schopnosť zefektívniť každodenné operácie tým, že ponúka bezpečnejší a lepšie spravovateľný systém správy poverení, ideálny pre jednoduché služby aj komplexné podnikové integrácie.

Nastavenia prístupu k API
Nastavenia prístupu k API

Ako to funguje

Enhanced API Access funguje prostredníctvom sofistikovaného systému správy poverení, ktorý zaisťuje bezpečnosť a prevádzkovú kontrolu. Jadrom tohto systému je konceptJednorazová tajná viditeľnosť, kde sú hodnoty poverení viditeľné iba v čase vytvorenia. FlytBase si zachováva chránenú jednosmernú reprezentáciu týchto poverení, čím bráni získaniu pôvodného tajomstva. Tento mechanizmus zaisťuje, že aj keď je poverenie odhalené, nemožno ho znova použiť alebo ďalej kompromitovať. Systém tiež poskytujeRozsah prevádzkovej kontroly, čo umožňuje spravovať prístup podľa integrácie. To znamená, že tímy môžu zakázať jedno poverenie bez toho, aby to ovplyvnilo ostatné systémy, čo poskytuje podrobnú úroveň kontroly nad prístupom k API.

Ďalšou kritickou súčasťou tohto systému je použitieKrátkodobé tokeny poverení klienta. Tieto tokeny vydávajú poverenia klienta a sú navrhnuté tak, aby boli krátkodobé, čím sa znižuje riziko v prípade odhalenia tokenu. Tokeny je možné obnoviť pomocou obnovovacích tokenov, čím sa zabezpečí, že prístup zostane bezpečný a pod kontrolou. Tento prístup výrazne znižuje riziko dlhodobého vystavenia prihlasovacích údajov a zlepšuje celkovú bezpečnostnú pozíciu systému.

Funkcia Enhanced API Access podporuje dve primárne možnosti správy poverení:API kľúčeaPoverenia klienta. Kľúče API sa používajú na priame volania API server-to-server s jedným poverením nosiča, vďaka čomu sú ideálne pre jednoduché služby. Na druhej strane, prihlasovacie údaje klienta sa používajú na integrácie, ktoré si vyžadujú výmenu ID klienta a tajomstva za prístupové tokeny s krátkou životnosťou, čo je vhodnejšie pre integrácie na podnikovej úrovni. Tento duálny prístup umožňuje flexibilitu a škálovateľnosť pri správe poverení API naprieč rôznymi typmi služieb a integrácií.

Rozhranie na správu kľúčov API
Rozhranie na správu kľúčov API

Predpoklady

Pred použitím funkcie Enhanced API Access sa uistite, že máte splnené nasledujúce predpoklady:

  • Aktívny účet FlytBase s oprávneniami správcu.
  • Prístup k riadiacemu panelu FlytBase, kde možno spravovať poverenia API.
  • Pochopenie vašich aktuálnych integrácií API a spôsobu ich konfigurácie.

Konfigurácia krok za krokom

  1. Prejdite na FlytBase Dashboard > API Credential Management. Tu môžete spravovať všetky poverenia API spojené s vaším účtom.
    1. Zobrazia sa možnosti pre kľúče API aj poverenia klienta.
  2. KliknitenaVytvoriť nový kľúč API. Táto akcia vygeneruje nový kľúč API, ktorý môžete použiť na volania API server-to-server.
    1. Zobrazí sa dialógové okno s novým kľúčom API. Pamätajte, že kľúč je viditeľný iba raz pri vytváraní.
  3. Vyberte Poverenia klientaz menu. Táto voľba vám umožňuje spravovať ID klientov a tajomstvá pre prístup na základe tokenov.
    1. Zobrazia sa polia na zadanie ID klienta a vygenerovanie tajomstva klienta.
  4. Zadajtepožadované podrobnosti preID klientaaTajomstvo klientaaKliknitenaGenerovať prístupový token. Tým sa vytvorí nová sada poverení klienta, ktorú možno použiť na integráciu rozhrania API.
    1. Vygenerovaný prístupový token je krátkodobý a možno ho obnoviť pomocou obnovovacieho tokenu.
  5. recenziazoznam aktívnych, expirovaných a zakázaných kľúčov vAPI kľúčeoddiele. To vám pomôže efektívne riadiť životný cyklus vašich kľúčov API.
    1. Kľúče môžete zakázať alebo odstrániť podľa potreby bez ovplyvnenia iných integrácií.
Rozhranie na správu poverení klienta
Rozhranie na správu poverení klienta

Obmedzenia a obmedzenia

KomponentPodrobnosti
Primárne použitieKľúče API: Priame volania server-to-server; Poverenia klienta: Výmena tokenov
Tajná viditeľnosťZobrazené raz pri vytvorení; nie je možné získať neskôr
Expirácia a výmenaplánovaná výmena a vymazanie kľúča; nové tajomstvá výmeny tokenov
Zakázať správanieOkamžite zastaví požiadavky API alebo vydávanie tokenov
Najlepšie fitKľúče API: Jednoduché služby; Poverenia klienta: Podnikové integrácie

Obmedzenia funkcie Enhanced API Access sú primárne zamerané na bezpečnosť a prevádzkovú kontrolu. Viditeľnosť tajomstiev je obmedzená na moment vytvorenia, aby sa zabránilo neoprávnenému prístupu. Toto obmedzenie zaisťuje, že aj keď je poverenie zverejnené, nemožno ho znova použiť. Plánované uplynutie platnosti a výmena kľúčov zabezpečujú pravidelné striedanie poverení, čím sa znižuje riziko dlhodobého vystavenia. Zakázanie poverení okamžite zastaví požiadavky API alebo vydávanie tokenov, čo poskytuje rýchly spôsob, ako zmierniť potenciálne narušenia bezpečnosti. Táto funkcia je najvhodnejšia pre prostredia, kde je kritické riadenie bezpečnosti a integrácie.


Edge Case & Troubleshooting

  • Problém: Po vytvorení nie je možné získať kľúč API.
    • Príčina: Kľúče API sú z bezpečnostných dôvodov viditeľné iba v čase vytvorenia.
    • Riešenie: Uistite sa, že ste kľúč API bezpečne uložili ihneď po jeho vygenerovaní.
  • Problém: Žiadosti API zlyhajú po zakázaní poverení.
    • Príčina: Zakázanie poverenia okamžite zastaví všetky požiadavky API, ktoré sú s ním spojené.
    • Riešenie: Skontrolujte svoje integrácie a uistite sa, že sú zakázané iba potrebné poverenia.
  • Problém: Platnosť tokenov s krátkou životnosťou často končí.
    • Príčina: Tokeny sú navrhnuté tak, aby boli krátkodobé, aby sa zvýšila bezpečnosť.
    • Riešenie: Implementujte vo svojej aplikácii mechanizmus obnovenia tokenu, aby ste zvládli vypršanie platnosti tokenu.
  • Problém: Ťažkosti pri migrácii z klasického na rozšírený prístup.
    • Príčina: Rozdiely v správe poverení a bezpečnostných postupoch.
    • Riešenie: Pre hladký prechod postupujte podľa sprievodcu migráciou, ktorý poskytuje FlytBase.

Súvisiace stránky

Was this helpful?