FlytBaseFlytBase Documentation

Accès API amélioré

Gérez les informations d'identification API en toute sécurité grâce à l'accès API amélioré.

Pre-Flight Modules

La fonctionnalité Enhanced API Access de FlytBase introduit une méthode robuste de gestion des informations d'identification API, offrant une amélioration significative par rapport aux modèles d'accès traditionnels. Cette fonctionnalité est conçue pour fournir des informations d'identification contrôlées pour chaque intégration, garantissant un stockage sécurisé et l'utilisation de jetons d'accès de courte durée. Il permet également de désactiver ou de supprimer l'accès sans affecter les autres systèmes, ce qui facilite la gestion et rend l'exploitation plus sûre. L'accès API amélioré répond aux défis posés par les anciens modèles d'accès, qui rendaient souvent difficile l'isolation des informations d'identification par intégration, l'application de contrôles de cycle de vie et la minimisation de l'impact lorsque les matériaux d'accès devaient être remplacés. En rendant chaque clé API ou secret client explicite et traçable, cette fonctionnalité améliore la sécurité et l'efficacité opérationnelle. Il s'intègre parfaitement dans le flux de travail plus large du produit FlytBase, en particulier pour les utilisateurs qui gèrent plusieurs intégrations et qui ont besoin d'un moyen sécurisé et gérable pour gérer les informations d'identification de l'API. Le principal avantage de l'accès API amélioré est sa capacité à rationaliser les opérations quotidiennes en offrant un système de gestion des informations d'identification plus sûr et plus gérable, idéal à la fois pour les services simples et les intégrations d'entreprise complexes.

Paramètres d'accès à l'API
Paramètres d'accès à l'API

Comment ça marche

L'accès API amélioré fonctionne via un système sophistiqué de gestion des informations d'identification qui garantit la sécurité et le contrôle opérationnel. Au cœur de ce système se trouve le concept deVisibilité secrète unique, où les valeurs des informations d'identification ne sont visibles qu'au moment de la création. FlytBase conserve une représentation unidirectionnelle protégée de ces informations d'identification, empêchant la récupération du secret d'origine. Ce mécanisme garantit que même si un identifiant est exposé, il ne peut pas être réutilisé ou compromis davantage. Le système fournit égalementContrôle opérationnel étendu, permettant de gérer l'accès par intégration. Cela signifie que les équipes peuvent désactiver un seul identifiant sans affecter les autres systèmes, offrant ainsi un niveau de contrôle granulaire sur l'accès aux API.

Un autre élément essentiel de ce système est l'utilisation deJetons d'informations d'identification client de courte durée. Ces jetons sont émis par les informations d'identification du client et sont conçus pour être de courte durée, réduisant ainsi le risque si un jeton est exposé. Les jetons peuvent être actualisés à l'aide de jetons d'actualisation, garantissant ainsi que l'accès reste sécurisé et sous contrôle. Cette approche réduit considérablement le risque d’exposition à long terme des informations d’identification et améliore la sécurité globale du système.

La fonctionnalité Enhanced API Access prend en charge deux options principales pour la gestion des informations d'identification :Clés APIetInformations d'identification du client. Les clés API sont utilisées pour les appels API directs de serveur à serveur avec un seul identifiant de porteur, ce qui les rend idéales pour les services simples. D'un autre côté, les informations d'identification client sont utilisées pour les intégrations qui nécessitent l'échange d'un identifiant client et d'un secret contre des jetons d'accès de courte durée, ce qui est plus adapté aux intégrations au niveau de l'entreprise. Cette double approche permet une flexibilité et une évolutivité dans la gestion des informations d'identification API sur différents types de services et d'intégrations.

Interface de gestion des clés API
Interface de gestion des clés API

Conditions préalables

Avant d'utiliser la fonctionnalité Accès API amélioré, assurez-vous que les conditions préalables suivantes sont remplies :

  • Un compte FlytBase actif avec des privilèges administratifs.
  • Accès au tableau de bord FlytBase où les informations d'identification API peuvent être gérées.
  • Compréhension de vos intégrations API actuelles et de la façon dont elles sont configurées.

Configuration étape par étape

  1. Accédez à Tableau de bord FlytBase > Gestion des informations d'identification API. C'est ici que vous pouvez gérer toutes les informations d'identification API associées à votre compte.
    1. Vous verrez des options pour les clés API et les informations d'identification client.
  2. CliquezsurCréer une nouvelle clé API. Cette action générera une nouvelle clé API que vous pourrez utiliser pour les appels API de serveur à serveur.
    1. Une boîte de dialogue apparaîtra montrant la nouvelle clé API. N'oubliez pas que la clé n'est visible qu'une seule fois lors de la création.
  3. Sélectionner Informations d'identification du clientdu menu. Cette option vous permet de gérer les ID client et les secrets pour un accès basé sur un jeton.
    1. Vous verrez des champs pour saisir un ID client et générer un secret client.
  4. Entrerles détails requis pourIdentifiant clientetSecret clientetCliquezsurGénérer un jeton d'accès. Cela créera un nouvel ensemble d'informations d'identification client qui pourra être utilisé pour les intégrations d'API.
    1. Le jeton d'accès généré est de courte durée et peut être actualisé à l'aide d'un jeton d'actualisation.
  5. Revoirla liste des clés actives, expirées et désactivées dans leClés APIsection. Cela vous aidera à gérer efficacement le cycle de vie de vos clés API.
    1. Vous pouvez désactiver ou supprimer des clés selon vos besoins sans affecter les autres intégrations.
Interface de gestion des informations d'identification client
Interface de gestion des informations d'identification client

Contraintes et limites

ComposanteDétails
Utilisation principaleClés API : appels directs de serveur à serveur ; Identifiants client : échange de jetons
Visibilité secrèteAffiché une fois lors de la création ; non récupérable plus tard
Expiration et remplacementRemplacement et suppression de clés planifiés ; nouveaux secrets pour l'échange de jetons
Désactiver le comportementArrête immédiatement les requêtes API ou l'émission de jetons
Meilleur ajustementClés API : services simples ; Identifiants client : intégrations d'entreprise

Les contraintes de la fonctionnalité Enhanced API Access se concentrent principalement sur la sécurité et le contrôle opérationnel. La visibilité des secrets est limitée au moment de la création pour empêcher tout accès non autorisé. Cette limitation garantit que même si un identifiant est exposé, il ne peut pas être réutilisé. L'expiration et le remplacement planifiés des clés garantissent une rotation régulière des informations d'identification, réduisant ainsi le risque d'exposition à long terme. La désactivation d'un identifiant arrête immédiatement les demandes d'API ou l'émission de jetons, offrant ainsi un moyen rapide d'atténuer les failles de sécurité potentielles. Cette fonctionnalité est particulièrement adaptée aux environnements dans lesquels la gestion de la sécurité et de l'intégration est essentielle.


Cas Edge et dépannage

  • Problème: Impossible de récupérer la clé API après la création.
    • Cause: Les clés API ne sont visibles qu'au moment de la création pour des raisons de sécurité.
    • Solution: Assurez-vous de stocker la clé API en toute sécurité immédiatement après sa génération.
  • Problème: les requêtes API échouent après la désactivation d'un identifiant.
    • Cause: la désactivation d'un identifiant arrête immédiatement toutes les requêtes API qui lui sont associées.
    • Solution: Vérifiez vos intégrations et assurez-vous que seules les informations d'identification nécessaires sont désactivées.
  • Problème: Les jetons de courte durée expirent fréquemment.
    • Cause: Les jetons sont conçus pour être de courte durée afin de renforcer la sécurité.
    • Solution: implémentez un mécanisme d'actualisation des jetons dans votre application pour gérer l'expiration des jetons.
  • Problème: Difficulté à migrer de l'accès classique vers l'accès amélioré.
    • Cause: Différences dans la gestion des informations d’identification et les pratiques de sécurité.
    • Solution: Suivez le guide de migration fourni par FlytBase pour une transition en douceur.

Pages connexes

Was this helpful?