FlytBaseFlytBase Documentation

Verbeterde API-toegang

Beheer API-gegevens veilig met verbeterde API-toegang.

Pre-Flight Modules

De Enhanced API Access-functie van FlytBase introduceert een robuuste methode voor het beheren van API-referenties, wat een aanzienlijke verbetering biedt ten opzichte van traditionele toegangspatronen. Deze functie is ontworpen om voor elke integratie gecontroleerde inloggegevens te bieden, waardoor veilige opslag en het gebruik van kortstondige toegangstokens worden gegarandeerd. Het maakt het ook mogelijk om toegang uit te schakelen of te verwijderen zonder dat dit gevolgen heeft voor andere systemen, waardoor het eenvoudiger te beheren en veiliger te bedienen is. De verbeterde API-toegang pakt de uitdagingen aan die gepaard gaan met oudere toegangspatronen, die het vaak moeilijk maakten om inloggegevens door integratie te isoleren, levenscycluscontroles af te dwingen en de impact te minimaliseren wanneer toegangsmaterialen moesten worden vervangen. Door elke API-sleutel of clientgeheim expliciet en traceerbaar te maken, verbetert deze functie de beveiliging en operationele efficiëntie. Het past naadloos in de bredere FlytBase-productworkflow, vooral voor gebruikers die meerdere integraties beheren en een veilige en beheersbare manier nodig hebben om met API-gegevens om te gaan. Het belangrijkste voordeel van Enhanced API Access is het vermogen om de dagelijkse activiteiten te stroomlijnen door een veiliger en beter beheerbaar referentiebeheersysteem aan te bieden, ideaal voor zowel eenvoudige services als complexe bedrijfsintegraties.

API-toegangsinstellingen
API-toegangsinstellingen

Hoe het werkt

Verbeterde API-toegang werkt via een geavanceerd referentiebeheersysteem dat veiligheid en operationele controle garandeert. De kern van dit systeem is het concept vanEenmalige geheime zichtbaarheid, waarbij referentiewaarden alleen zichtbaar zijn op het moment van creatie. FlytBase behoudt een beschermde eenrichtingsweergave van deze inloggegevens, waardoor het ophalen van het oorspronkelijke geheim wordt voorkomen. Dit mechanisme zorgt ervoor dat zelfs als een inloggegevens openbaar worden gemaakt, deze niet opnieuw kan worden gebruikt of verder kan worden aangetast. Het systeem biedt ookScoped operationele controle, waardoor de toegang per integratie kan worden beheerd. Dit betekent dat teams één enkele inloggegevens kunnen uitschakelen zonder dat dit gevolgen heeft voor andere systemen, waardoor een gedetailleerd niveau van controle over API-toegang wordt geboden.

Een ander cruciaal onderdeel van dit systeem is het gebruik vanKortstondige klantreferentietokens. Deze tokens worden uitgegeven op basis van klantreferenties en zijn ontworpen om van korte duur te zijn, waardoor het risico wordt verkleind als een token wordt blootgesteld. De tokens kunnen worden vernieuwd met behulp van vernieuwingstokens, zodat de toegang veilig en onder controle blijft. Deze aanpak vermindert het risico op langdurige blootstelling van inloggegevens aanzienlijk en verbetert de algehele beveiligingspositie van het systeem.

De functie Verbeterde API-toegang ondersteunt twee primaire opties voor het beheren van inloggegevens:API-sleutelsEnKlantreferenties. API-sleutels worden gebruikt voor directe server-naar-server API-aanroepen met één dragerreferentie, waardoor ze ideaal zijn voor eenvoudige services. Aan de andere kant worden klantreferenties gebruikt voor integraties waarbij een client-ID en geheim moeten worden uitgewisseld voor kortstondige toegangstokens, wat geschikter is voor integraties op ondernemingsniveau. Deze dubbele aanpak zorgt voor flexibiliteit en schaalbaarheid bij het beheren van API-referenties voor verschillende soorten services en integraties.

Beheerinterface voor API-sleutels
Beheerinterface voor API-sleutels

Vereisten

Voordat u de functie Verbeterde API-toegang gebruikt, moet u ervoor zorgen dat u aan de volgende vereisten voldoet:

  • Een actief FlytBase-account met beheerdersrechten.
  • Toegang tot het FlytBase-dashboard waar API-gegevens kunnen worden beheerd.
  • Inzicht in uw huidige API-integraties en hoe deze zijn geconfigureerd.

Stapsgewijze configuratie

  1. Navigeer naar FlytBase Dashboard > API-referentiebeheer. Hier kunt u alle API-inloggegevens beheren die aan uw account zijn gekoppeld.
    1. U ziet opties voor zowel API-sleutels als klantreferenties.
  2. KlikopMaak een nieuwe API-sleutel. Met deze actie wordt een nieuwe API-sleutel gegenereerd die u kunt gebruiken voor server-naar-server API-aanroepen.
    1. Er verschijnt een dialoogvenster met de nieuwe API-sleutel. Houd er rekening mee dat de sleutel bij het maken slechts één keer zichtbaar is.
  3. Selecteer Klantreferentiesuit het menu. Met deze optie kunt u client-ID's en geheimen beheren voor op tokens gebaseerde toegang.
    1. U ziet velden voor het invoeren van een klant-ID en het genereren van een klantgeheim.
  4. Binnenkomende benodigde gegevens voorKlant-IDEnKlantgeheimEnKlikopToegangstoken genereren. Hierdoor wordt een nieuwe set klantgegevens gemaakt die kan worden gebruikt voor API-integraties.
    1. Het gegenereerde toegangstoken is van korte duur en kan worden vernieuwd met behulp van een vernieuwingstoken.
  5. Beoordelingde lijst met actieve, verlopen en uitgeschakelde sleutels in hetAPI-sleutelssectie. Dit zal u helpen de levenscyclus van uw API-sleutels effectief te beheren.
    1. U kunt indien nodig sleutels uitschakelen of verwijderen zonder dat dit gevolgen heeft voor andere integraties.
Beheerinterface voor klantreferenties
Beheerinterface voor klantreferenties

Beperkingen en beperkingen

OnderdeelDetails
Primair gebruikAPI-sleutels: directe server-naar-server-oproepen; Klantreferenties: tokenuitwisseling
Geheime zichtbaarheidEenmaal getoond bij creatie; later niet meer terug te halen
Vervaldatum en vervangingGeplande vervanging en verwijdering van sleutels; nieuwe geheimen voor tokenuitwisseling
Gedrag uitschakelenStopt API-aanvragen of tokenuitgifte onmiddellijk
Beste pasvormAPI-sleutels: eenvoudige services; Klantreferenties: Enterprise-integraties

De beperkingen van de functie Verbeterde API-toegang zijn voornamelijk gericht op beveiliging en operationele controle. De zichtbaarheid van geheimen is beperkt tot het moment van creatie om ongeoorloofde toegang te voorkomen. Deze beperking zorgt ervoor dat zelfs als een inloggegevens openbaar worden gemaakt, deze niet opnieuw kan worden gebruikt. Het geplande verlopen en vervangen van sleutels zorgt ervoor dat inloggegevens regelmatig worden gerouleerd, waardoor het risico op langdurige blootstelling wordt verminderd. Het uitschakelen van een inloggegevens stopt onmiddellijk de API-aanvragen of de uitgifte van tokens, waardoor een snelle manier wordt geboden om potentiële beveiligingsinbreuken te beperken. De functie is het meest geschikt voor omgevingen waar beveiliging en integratiebeheer van cruciaal belang zijn.


Edge-cases en probleemoplossing

  • Probleem: Kan de API-sleutel niet ophalen na het maken.
    • Oorzaak: API-sleutels zijn om veiligheidsredenen alleen zichtbaar op het moment van creatie.
    • Oplossing: Zorg ervoor dat u de API-sleutel onmiddellijk nadat deze is gegenereerd, veilig opslaat.
  • Probleem: API-verzoeken mislukken na het uitschakelen van een referentie.
    • Oorzaak: Als u een referentie uitschakelt, worden alle bijbehorende API-verzoeken onmiddellijk stopgezet.
    • Oplossing: Controleer uw integraties en zorg ervoor dat alleen noodzakelijke inloggegevens zijn uitgeschakeld.
  • Probleem: Tokens met een korte levensduur verlopen regelmatig.
    • Oorzaak: Tokens zijn ontworpen om van korte duur te zijn om de veiligheid te verbeteren.
    • Oplossing: Implementeer een mechanisme voor het vernieuwen van tokens in uw toepassing om het verlopen van tokens af te handelen.
  • Probleem: Moeilijkheid bij het migreren van klassieke naar verbeterde toegang.
    • Oorzaak: Verschillen in referentiebeheer en beveiligingspraktijken.
    • Oplossing: Volg de migratiegids van FlytBase om de overgang soepel te laten verlopen.

Gerelateerde pagina's

Was this helpful?