Accéder au contenu principal Passer au contenu complémentaire

Définir une sécurité d'API

Au cours du processus de définition de l'API, vous devez spécifier quels consommateurs accèdent à votre API (authentification) et ce qu'ils peuvent faire (autorisation).

Note InformationsRemarque : Talend Cloud API Designer vous permet de définir des paramètres de sécurité à des fins de conception et de documentation mais la sécurité n'est pas automatiquement implémentée lorsque vous utilisez la définition d'API dans le Studio Talend.

Vous pouvez définir une politique de sécurité commune à toute votre API ou choisir une politique plus granulaire avec une sécurité spécifique pour les ressources critiques.

Vous pouvez également spécifier que certaines opérations sont accessibles sans authentification.

Talend Cloud API Designer peut gérer toutes ces situations avec les types de sécurité principaux :
  • authentification basique (Basic) ;
  • authentification Bearer ;
  • authentification Digest ;
  • OAuth 1.0 ;
  • OAuth 2.0
  • OpenID Connect ;
  • personnalisée/clé API ;
  • authentification directe (Pass through).

L'authentification par cookie n'est pas supportée.

Créer un schéma de sécurité

Créez un schéma de sécurité à utiliser dans toute votre version d'API ou dans des éléments individuels.

Procédure

  1. Allez à la page des informations générales de votre API.
  2. Accédez à la section Security schemes (Schémas de sécurité) et cliquez sur Add (Ajouter) pour créer un nouveau schéma.
  3. Sélectionnez un Name (Nom) et sélectionnez un Type dans la liste déroulante.
  4. Facultatif : Saisissez une Description.
  5. Saisissez d'autres paramètres spécifiques au type sélectionné.

    Exemple

    Exemple de définition de schéma de sécurité.

Résultats

Votre schéma de sécurité est créé, vous pouvez l'utiliser dans les paramètres globaux de votre API ou dans des ressources et opérations spécifiques.

Définir votre sécurité d'API

Définissez les schémas de sécurité pour votre API, vos ressources et vos opérations.

Procédure

  1. Allez à la page des informations générales de votre API.
  2. Dans la section Global security (Sécurité globale), ajoutez vos schémas de sécurité et sélectionnez ceux à appliquer de manière globale à votre version d'API.
    Dans cet exemple, l'API Petstore est sécurisée par petstore_auth avec le périmètre write:pets.
  3. Sélectionnez une ressource et sélectionnez les schémas de sécurité à appliquer à toutes vos opérations de ressources.
    De manière alternative, vous pouvez sélectionner une opération pour définir sa sécurité spécifique.
    Dans cet exemple, la méthode Find Pets by tags est sécurisée via petstore_auth.

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – faites-le-nous savoir.