Tutoriel Okta Workflows : Créer un connecteur pour l’API OpenWeather

Ce tutoriel vous apprendra à créer un connecteur pour l'API OpenWeather à l'aide d'Okta Workflows Connector Builder.

• Connecteur pour l'API OpenWeather
• Qu'est-ce que le Connector Builder ?
• Créer un connecteur pour l’API OpenWeather
• Ressources

Connecteur pour l'API OpenWeather

Vous avez plusieurs flux de notification par e-mail que vous avez créés dans Okta Workflows. Lorsque vous activez un utilisateur, vous souhaitez inclure des informations météorologiques dans l'e-mail de bienvenue.

Vous souhaitez utiliser OpenWeather pour obtenir des informations météorologiques. Il n'existe pas de connecteur préintégré pour OpenWeather dans Workflows aujourd'hui.

Plusieurs membres de l'équipe ne sont pas familiers avec la configuration des appels d'API. Pour les aider à utiliser OpenWeather, vous allez créer un connecteur pour OpenWeather à l'aide du générateur de connecteurs Okta Workflows (Okta Workflows Connector Builder).

Un connecteur préintégré pour OpenWeather simplifiera l'ajout d'informations météorologiques aux flux et aux e-mails.

Qu'est-ce que le Connector Builder ?

Okta Workflows Connector Builder est un outil sans code permettant de créer des connecteurs API. Un connecteur apparaîtra dans la liste des connecteurs, et vous pouvez l’utiliser pour créer des flux d’automatisation d’identité.

Le Connector Builder utilise des flux Workflows et des cartes (action, fonction) pour créer un connecteur.

Lisez Comprendre les connecteurs Okta Workflows pour en savoir plus sur les différentes options d’appel d’API dans Okta Workflows et sur le moment d’utiliser chaque option.

Un connecteur est constitué de plusieurs flux :

• Un flux pour effectuer la requête HTTP.
• Un flux pour vérifier que l'authentification auprès du service fonctionne.
• Un ou plusieurs flux d'action. Chaque flux d'action appelle le point de terminaison API d'un service.
• Flux d'action personnalisé pour permettre d'appeler n'importe quel point de terminaison API sur le service.

Un connecteur peut avoir d'autres flux, tels que l'authentification OAuth. Ce tutoriel ne couvrira pas l'authentification OAuth.

Remarque: La création d'un connecteur dans le Connector Builder est un sujet avancé. Suivez d'abord les didacticiels de mise en route si vous êtes novice en matière d'Okta Workflows.

Créer un connecteur pour l’API OpenWeather

Vous avez besoin d'une clé API OpenWeather avant de commencer à créer le connecteur.

Obtenir la clé d'API OpenWeather

1. Créer un compte OpenWeather pour obtenir une clé API.
   • C'est généralement plus rapide, mais la clé API peut prendre jusqu'à deux heures pour être activée.

Accédez à l'onglet Clés API pour afficher et gérer vos clés API.

Vous utiliserez une clé API de cette page dans les sections suivantes.

Créer un projet de connecteur

1. Cliquez sur les quatre carrés dans le coin supérieur droit de Workflows et sélectionnez Connector Builder.
2. Cliquez sur J’accepte, laissez-moi entrer ! pour accepter les conditions du générateur de connecteurs.

Lancez le Concepteur de connecteurs.

3. Cliquez sur + Nouveau connecteur pour créer un projet de connecteur.
   • Cliquez sur le ➕ dans le panneau de gauche si vous avez déjà créé un projet de connecteur.
4. Entrez OpenWeather pour le Nom du connecteur.
5. Entrez Le connecteur OpenWeather fournit des informations météorologiques. pour la Description de la connexion.
6. Cliquez sur Save pour enregistrer le projet de connecteur.

Vous verrez la page Aperçu du connecteur.

Projet de connecteur.

Vous reviendrez sur cette page plus tard pour définir l'icône du connecteur et d'autres informations.

Flux de connecteur et authentification

Le connecteur que vous allez créer comporte cinq flux :

• httpHelper : gère toutes les authentifications et les requêtes HTTP pour le connecteur.
• authPing : vérifie l'état de la connexion.
• Current : une action pour obtenir la météo actuelle à partir du point de terminaison de l'API de météo actuelle.
• Prévisions : une action pour obtenir des prévisions météorologiques à cinq jours à partir du point de terminaison API de prévisions à 5 jours.
• Action API personnalisée : une action pour appeler n'importe quel point de terminaison API à partir d'OpenWeather API.

Le connecteur possède également une Authentication.

L'authentification est l'endroit où vous définissez les paramètres requis pour créer une connexion sécurisée à un service d'API.

Lorsqu'un utilisateur final crée une connexion à votre service, la boîte de dialogue Nouvelle connexion recueille les détails d'authentification spécifiques.

Il existe trois types d'authentification :

• Basic: utilise le nom d'utilisateur et le mot de passe.
• OAuth 2.0 : accorde un accès limité aux ressources à un tiers. Vous pouvez utiliser les types d'octroi de code d'autorisation ou d'informations d'identification du client dans un connecteur.
• Personnalisé: utilise la clé API ou un autre processus d'authentification.

Créer une authentification pour l'API OpenWeather

L'API OpenWeather transmet une clé API dans la requête pour l'authentification. Vous configurerez une authentification personnalisée avec une clé API pour le connecteur.

1. Sur la page Aperçu, cliquez sur Configurer l’authentification pour créer une connexion.
2. Sélectionnez Personnalisé dans la liste Type d’authentification.
3. Cliquez sur Ajouter un paramètre.
4. Entrez la Clé API pour le Label.
5. Saisissez appid pour la Key et conservez Text pour le Type.
6. Cliquez sur Enregistrer pour enregistrer les informations de connexion.

Configuration de l’authentification.

Le nom du paramètre (clé) est appid, car l’appel d’API OpenWeather utilise ce nom:

https://api.openweathermap.org/data/2.5/weather?q={city name}&units={units}&appid={API key}

 

Créer un flow pour faire des requêtes HTTP

Vous allez créer un flux nommé httpHelper.

Le httpHelper est un flux système qui gère l'authentification et les requêtes HTTP pour le connecteur. Le flux httpHelper est un flux d'assistance; d'autres flux peuvent l'appeler. Le flux a :

• Plusieurs entrées.
• Cartes de fonction pour créer des informations de requête, d’en-tête et de corps de requête.
• La carte HTTP – Raw Request pour effectuer un appel à une API.
• Plusieurs sorties.

Créer un flow

1. Ouvrez la page Flows.
2. Pour créer un flux, cliquez sur + Nouveau flux.
3. Cliquez sur Unnamed dans le coin supérieur gauche pour nommer le flux.
4. Saisissez httpHelper pour le Nom de flux.
5. Entrez Ce flux gère toutes les demandes d'authentification et HTTP pour le connecteur. pour la description.
6. Cochez l'option Save all data that passes through the Flow? option.
7. Pour enregistrer le flow, cliquez sur Save.

Configurer les entrées de flux

1. Cliquez sur Ajouter un événement et choisissez Flux d'assistance.
2. Ajoutez les champs suivants sur la carte Helper Flow :
   • relative_url (type : Texte).
   • request_method (Texte).
   • query (Objet).
   • headers (Objet).
   • body (Objet).

Le flux httpHelper se présente comme suit :

flux httpHelper.

Configurer l'URL de l'API

Le connecteur prendra en charge plusieurs endpoints OpenWeather. L'URL de base reste la même et l'URL relative changera. Vous devez combiner les deux valeurs en une URL complète.

1. Ajoutez la carte Texte - Concaténer après la carte Flux d'aide.
2. Saisissez https://api.openweathermap.org dans le champ texte 1.
3. Connectez relative_url au champ text 2.
4. Renommez le champ de sortie de la carte.
   • Pour modifier la carte, cliquez sur ⚙️ > Modifier la carte.
   • Pour renommer le champ de sortie, cliquez sur son icône ✏️ et définissez le nom sur full_url.

Définition de l’URL du service.

Pour tester la carte :

1. Au bas de la carte, cliquez sur ▶️.
2. Entrez /data/2.5/weather URL relative pour text 2.
3. Cliquez sur Test pour voir l'URL complète : https://api.openweathermap.org/data/2.5/weather.

Configurer la requête API

Comme vous l'avez fait à l'étape précédente, vous devez combiner les informations de requête de l'utilisateur avec les informations de la clé API.

1. Ajoutez la carte Object – Merge après la carte Text – Concatenate.
2. Connect:
   • query au champ object 1.
   • Connection au champ object 2.
3. Renommez le champ de sortie en merged_query.

Le flux ressemble à ceci :

Configuration de la requête de service.

Effectuer un appel d’API

Vous êtes prêt à ajouter une étape pour effectuer l'appel API à OpenWeather.

1. Ajoutez la carte HTTP – Raw Request après la carte Merge.
2. Créez les connexions suivantes :
   • full_url au champ url sur la carte Raw Request.
   • request_method à la méthode sur la carte Raw Request.
   • headers de la carte Helper Flow vers le champ headers sur la carte Raw Request.
   • merged_query au champ query.
   • body au champ body.

Le flux ressemble à ceci :

Configuration de la requête HTTP.

Vous pouvez tester la carte HTTP – Requête brute si vous le souhaitez.

1. Cliquez sur ▶️ pour tester la carte.
2. Pour le champ url, entrez : https://api.openweathermap.org/data/2.5/weather
3. Entrez GET pour le champ method.
4. Pour le champ query, entrez (remplacez la valeur appid par votre clé API OpenWeather) :

{
    "q": "Rome, IT",
    "units":"metric",
    "appid": "89b03d9e1df4094dda81b5bc2b01ad5a"
}

4. Cliquez sur Test pour tester la carte.

La dernière étape consiste à configurer les sorties du flux.

Configurer les sorties de flux

1. Connectez les champs statusCode, headers et body de la carte HTTP – Raw Request à la carte Flow Control – Return.
2. Remplacez le type de champ body par Object.

httpHelper output.

Testez le flux httpHelper

Vous avez créé un flux avec plusieurs entrées. L'une des entrées est un point de terminaison de l'API OpenWeather (relative_url). Le flux appelle le point de terminaison de l'API et renvoie une réponse (statusCode, headers et body).

Il est recommandé de tester le flux.

1. Pour tester le flux, cliquez sur le bouton Run.
2. Sélectionnez New connection dans la liste Test Connection.
3. Saisissez Connexion OpenWeather pour le Nom.
4. Saisissez Connexion API OpenWeather pour la Description.
5. Entrez votre clé API OpenWeather pour la API Key.
6. Cliquez sur Créer.

Vous avez créé une connexion à l'API OpenWeather.

Ensuite, fournissez le reste des informations pour l'entrée du flow :

Entrée pour le flux httpHelper.

1. Entrez /data/2.5/weather pour relative_url.
2. Entrez GET pour request_method.
3. Pour la query, entrez avec votre clé API OpenWeather :

{
    "q": "Rome,IT",
    "units":"metric"
}

4. Laissez les champs headers et body vides.
5. Cliquez sur Run pour exécuter le flux.

Test du flux httpHelper.

Si vous le souhaitez, vous pouvez créer une fausse connexion qui entraînera une erreur. La fausse connexion vous aidera à voir comment le connecteur fonctionne lorsque l'authentification échoue.

Fausse connexion.

Vous avez créé et testé le flow httpHelper. D'autres flows de connecteur appelleront le flow httpHelper.

La section suivante vous apprendra à créer un autre flux système. Ce flux vérifiera si l'authentification au service fonctionne.

Créer un flux pour vérifier une connexion valide

Vous allez créer un flux nommé _authPing. Un flux _authPing est un flux système utilisé par la plateforme pour appeler une API et vérifier l'autorisation valide.

Cette action sert de contrôle de validation et s'exécute lorsque vous authentifiez le connecteur pour la première fois, ajoutez de nouveaux connecteurs ou ouvrez des flux.

Créer un flow

1. Revenir à la vue du projet de connecteur.
2. Cliquez sur + New Flow depuis la page Flows.
3. Cliquez sur Add event, et sélectionnez l'événement Authping.
4. Pour enregistrer le flux, cliquez sur Sans nom dans le coin supérieur gauche.
5. Entrez _authping pour le Nom.
6. Saisissez Vérification de l’état de la connexion. pour la description.
7. Cochez l'option Save all data that passes through the Flow? option.
8. Cliquez sur Save.

Nouveau flux authping.

Ajouter des cartes de contrôle de l'état de la connexion

1. Cliquez sur Ajouter une fonction, et sélectionnez la carte Gestion des erreurs – Si erreur.
2. Dans le bloc Try (automatiquement sélectionné), cliquez sur ➕, puis sur function (icône de calculatrice) et sélectionnez la carte Flow Control – Call Flow.
3. Sur la carte Call Flow, cliquez sur Choose Flow.
4. Sélectionnez le flux httpHelper, puis cliquez sur Choose.

Le flux ressemble à ceci :

Flux authping avec la carte Call Flow.

Ce flux appelle le flux httpHelper pour vérifier que la connexion au service fonctionne. Vous devez utiliser un point de terminaison d'API qui nécessite une authentification.

Remarque: l'équipe Okta Workflows recommande une requête avec la plus petite taille de réponse. Par exemple, certaines API ont un point de terminaison /me pour obtenir des informations sur l'utilisateur connecté.

OpenWeather ne fournit pas de point de terminaison /me. Vous utiliserez une requête régulière pour vérifier l’état de la connexion.

Terminez la configuration de la carte Call Flow :

1. Entrez /data/2.5/weather pour le relative_url.
2. Entrez GET pour request_method.
3. Pour query, saisissez :

{
  "q": "Rome,IT"
}

4. Laissez les champs headers et body vides. Vous n'avez pas non plus besoin d'units dans la requête, car il ne s'agit que d'une requête ping.
5. Connectez le champ Connection de la première carte au champ Connection sur la carte Call Flow.

Le flux ressemble à ceci :

flux authping avec la carte Appel de flux configurée.

Pour créer des sorties sur la carte Call Flow :

1. Cliquez à l'intérieur de la zone Click or drag to create et créez les champs de sortie suivants :
   • statusCode (type Nombre).
   • headers (Objet).
   • body (Objet).

Flux d'appel avec sorties.

Ensuite, vous configurerez un message lorsque la connexion fonctionne et un message lorsque la connexion ne fonctionne pas.

Pour configurer un message en cas de connexion fonctionnelle :

1. Cliquez sur le ➕ après la carte Call Flow à l'intérieur de la carte If Error et sélectionnez la carte Flow Control – Assign.
2. Ajoutez un champ message et définissez-le sur la valeur The connection is successful dans la carte Control – Assign .

Créer des sorties pour la carte If Error :

1. Cliquez sur View Outputs dans la carte If Error (coin supérieur droit). La carte ouvre une section où vous définissez les sorties de la carte.
2. Cliquez à l'intérieur du champ et créez deux sorties :
   • statusCode.
   • message.
3. Créez les connexions suivantes :
   • statusCode de la carte Call Flow vers le premier sous-champ de statusCode.
   • message de la carte Assign au premier sous-champ du message.

La carte ressemble à ceci :

Configurez un message lorsque la connexion fonctionne.

Pour configurer un message lorsque la connexion ne fonctionne pas :

1. À l'aide de la liste où il est écrit Essayer, passez au bloc Si erreur sur la carte Si erreur.
2. Ajoutez deux champs à l'objet Error :
   • statusCode (type Text).
   • description (Texte).
3. Cliquez sur ➕ à droite de l'objet Error à l'intérieur du bloc If Error et ajoutez la carte Text – Concatenate.
4. Créez les connexions suivantes :
   • description de l'objet Erreur vers le champ text 1.
   • Entrez : (deux-points) dans le champ text 2.
   • Cliquez pour créer un troisième champ et connectez message de Error à celui-ci.

Ensuite, vous connecterez le message à la sortie de la carte If Error (en cas d’erreur).

1. Cliquez sur Afficher les sorties sur la carte Si Erreur.
2. Créez les connexions suivantes :
   • statusCode de Error au deuxième sous-champ de statusCode.
   • output de Concatenate vers le deuxième sous-champ de message.

La carte ressemble à ceci :

Configurez un message lorsque la connexion ne fonctionne pas.

Configurer les sorties de flux

La carte Flow Control – Return Status comporte deux champs : working et serviceResponse. Vous utiliserez les informations disponibles dans ce flux pour définir ces champs.

1. Cliquez sur ➕ après la carte If Error et ajoutez la carte True/False – Compare.
2. Connectez statusCode de la sortie de la carte If Error au champ value a.
3. Entrez 200 pour le champ value b.
4. Renommez le champ de sortie result en working.

Configuration du code d'état de la connexion.

Si l'appel à l'API réussit (200), vous savez que la connexion fonctionne.

1. Cliquez sur ➕ après la carte Vrai/Faux – Comparer et ajoutez la carte Objet – Construire.
2. Créez deux champs sur la carte Construct :
   • statusCode (type Text).
   • body (Texte).
3. Créez les connexions suivantes :
   • statusCode de la sortie de la carte If Error vers le champ statusCode sur la carte Construct.
   • message de la sortie de la carte Si erreur au champ body sur la carte Construct.
4. Renommez le champ output sur la carte Construct en serviceResponse.

Configuration de la réponse de l'état de la connexion.

Pour configurer les sorties de flux :

1. Connectez le champ working de la carte Compare au champ working de la carte Return Status.
2. Connectez serviceResponse de la carte Construct au champ serviceResponse sur la carte Return Status.

Le flux complet :

Le flux authping complet.

Tester le flux

1. Enregistrer le flux.
2. Cliquez sur Exécuter.
3. Sélectionnez une connexion fonctionnelle et cliquez sur Exécuter.

Test de l'authping.

Sélectionnez une connexion non fonctionnelle que vous avez créée et relancez le flow.

Dans cette section, vous avez créé le deuxième flux système nommé _authping. Le premier flux système est httpHelper.

Dans les sections suivantes, vous allez créer des flux d'action qui effectuent les appels d'API à l'aide des flux système.

Créer une action pour la météo actuelle

Dans cette section, vous allez créer une action de connecteur pour le point de terminaison météo actuel d'OpenWeather.

Créer un flow

1. Retournez à la vue du projet du connecteur.
2. Cliquez sur + New Flow pour créer un nouveau flux.
3. Cliquez sur Unnamed dans le coin supérieur gauche pour nommer le flux.
4. Entrez Actuel pour le Nom du flux.
5. Entrez Cette action renvoie les données météorologiques actuelles pour une ville. pour la Description.
6. Cochez l'option Save all data that passes through the Flow? option
7. Cliquez sur Enregistrer pour enregistrer le flux.

Configurez le flux comme une action

Un flux d'action effectue un appel d'API de service.

Pour configurer ce flux en tant que flux d'action :

1. Cliquez sur Add event, puis sur le type d'événement Action.

Le flux ressemble à ceci :

Nouveau flux d'action.

Configurer les entrées d'action

Les entrées d'action sont toutes les entrées dont vous avez besoin pour effectuer un appel API au service sous-jacent.

Vous utiliserez la demande d'API d'OpenWeather par nom de ville et pays pour cette action. Cela signifie que le connecteur a besoin de trois entrées : city, country et units.

Pour configurer les entrées :

1. Cliquez sur Add Inputs sur la carte Connector Action.
2. Ouvrez la liste Ajouter un groupe et sélectionnez Ajouter un groupe statique.
3. Créer l'entrée pour la ville:
   • Label: Ville.
   • Field Type: Champ de texte.
   • Type de données: Texte.
   • Required: oui.
4. Ajoutez l'entrée pour le pays :
   • Label: Pays.
   • Field Type: Champ de texte.
   • Type de données: Texte.
   • Required: no.
5. Ajouter l'entrée pour les unités :
   • Étiquette: Unités.
   • Field Type: Dropdown.
   • Type de données: Texte.
   • Required: no.
   • Ajouter trois options pour les unités :
     • Option: Celsius, Value: metric.
     • Option: Fahrenheit, Value: imperial.
     • Option: Kelvin, Value: standard.

Vous pouvez voir un aperçu de la carte sur le côté droit.

Voici à quoi ressemble la configuration :

Configuration des entrées d'action.

6. Cliquez sur Appliquer pour enregistrer les entrées.

Voici à quoi ressemble le flux :

Flux d'action avec entrées.

Formater les entrées pour l’appel d’API

Vous devez formater les entrées dans un format requis par l'API OpenWeather. Voici à quoi ressemble un appel API :

https://api.openweathermap.org/data/2.5/weather?q={city name},{country code},units={units}&appid={API key}

Vous devez formater les entrées comme suit :

q={city name},{country code}&units={units}

Par exemple :

q=Rome,IT&units=metric

Vous utiliserez plusieurs cartes pour créer cette requête.

Tout d'abord, configurez la requête pour le paramètre q :

1. Ajoutez la carte Texte – Concaténer après la carte Action de connecteur.
2. Créez les connexions suivantes :
   • City à text 1 sur la carte Concatenate.
   • Entrez , (virgule) pour le champ text 2 sur la carte Concatenate.
   • Country au troisième champ de la carte Concaténer.
3. Ajoutez la carte Object – Construct après la carte Concatenate.
4. Créez un champ et nommez le champ q.
5. Connectez la output de la carte Concatenate au champ q.
6. Renommez le champ output en query1.

Configurer la requête pour le paramètre q.

Ensuite, vous configurerez la requête pour le paramètre unités :

1. Ajoutez la carte Objet - Construire.
2. Créez un champ et nommez-le units.
3. Connectez Units de la première carte aux unités sur la carte Construct.
4. Renommez la sortie de la carte Construct en query2.

Ensuite, vous fusionnerez les deux requêtes.

1. Ajouter la carte Objet – Fusionner.
2. Connectez query1 au champ object 1 et query2 au champ object 2.
3. Renommer la sortie de la carte en full_query.

Voici à quoi ressemble le flux :

Configurer la requête pour les paramètres q et units.

Appeler l'API OpenWeather

Dans cette étape, vous allez effectuer un appel à OpenWeather API.

1. Ajoutez la carte Flow Control – Call Flow.
2. Cliquez sur Choose Flow, sélectionnez le flux httpHelper et cliquez sur Choose.
3. Entrez /data/2.5/weather pour le champ relative_url.
4. Entrez GET pour request_method.
5. Connectez full_query au champ query sur la carte Call Flow.
6. Connectez le champ Connection de la première carte au champ Connection sur la carte Call Flow.
7. Créez trois sorties pour la carte Call Flow :
   • statusCode (type Number).
   • headers (type Object).
   • body (type Object).

La carte Call Flow.

Créer des sorties de flux

Créez les sorties suivantes sur la carte Flow Control – Return Outputs :

1. Cliquez sur Add Outputs.
2. Ouvrez Ajouter un groupe et sélectionnez Ajouter un groupe statique.
3. Créer trois sorties :
   • Code d'état (type Number).
   • Headers (Objet).
     • Supprimez l'entrée de clé vide.
   • Body (Objet).
     • Supprimez l'entrée de clé vide.
4. Cliquez sur Appliquer pour enregistrer les sorties.
5. Connectez les données de la carte Call Flow à la carte Return Outputs :
   • statusCode au champ Status Code.
   • headers au champ Headers.
   • body au champ Body.

La fin du flux ressemble à ceci :

Flow d'action actuel avec les sorties.

Tester le flux

1. Enregistrez le flux et cliquez sur Exécuter pour tester le flux.
2. Entrez une ville et un pays et cliquez sur Exécuter.

Vous êtes prêt à déployer et à essayer l’action de connecteur.

Déployer le connecteur

Activer les flux

Les flux doivent être activés avant le déploiement.

1. Retournez à la page Flows.
2. Activez les trois flux.

Mettre à jour les paramètres du connecteur

Dans cette section, vous entrerez des informations supplémentaires dans les paramètres.

1. Revenir à la vue principale du projet.
2. Ouvrez la page Overview.
3. Cliquez sur Edit dans la section Settings.
4. Mettez à jour le nom du connecteur vers Weather.
5. Recherchez et chargez une icône météo à utiliser pour le connecteur.
   • Ce tutoriel utilise une icône de Icônes météo créées par iconixar – Flaticon.
6. Modifiez la Accent Color si vous le souhaitez.
7. Saisissez les informations User Documentation URL et Support Contact Email.
8. Cliquez sur Enregistrer pour enregistrer toutes les modifications.

Paramètres du connecteur.

Déployer le connecteur

Pour déployer le connecteur :

1. Passez à l'onglet Deployment.
2. Cliquez sur Create test version.
3. Sélectionnez les trois points verticaux sous Actions pour une version test que vous avez créée et sélectionnez Deploy Version.

Vous verrez le connecteur déployé dans la section Private deployment après environ 20 à 30 secondes.

Déploiement du connecteur.

Vous êtes prêt à utiliser le connecteur dans un flux.

Utilisation du connecteur dans un flux

Dans cette étape, vous allez utiliser l'action de connecteur dans un flux.

Ajoutez le connecteur Weather.

Ajoutez la carte

1. Créez un nouveau flux dans Workflows.
2. Cliquez sur Add app action et sélectionnez le connecteur Weather. Vous pouvez également le rechercher.
3. Sélectionnez l'action Current.

Créer une connexion

Puisqu’il s’agit de votre première utilisation du connecteur, vous devez créer une connexion à l’API.

1. Cliquez sur + New Connection.
2. Conserver le nom du connecteur.
3. Saisissez OpenWeather connection pour le champ Description.
4. Entrez votre clé OpenWeather API pour le champ API Key. Vous pouvez trouver la clé API sur la page des clés API.
5. Cliquez sur Créer pour créer la connexion.

Test

La carte Weather – Current.

1. Saisissez une Ville, un Pays et choisissez des Unités sur la fiche Weather – Current.
2. Cliquez sur Run pour tester le flux. Vous pouvez également tester la carte.

Test d'un flux avec la carte Weather – Current.

Félicitations ! Vous avez créé un connecteur avec une action et l'avez utilisé dans un flux. Vous ajouterez deux actions supplémentaires au connecteur dans les deux sections suivantes.

Créer une action pour une prévision à 5 jours

Dans cette section, vous allez créer une action de connexion pour les prévisions météorologiques à 5 jours. Vous allez dupliquer l'action Current existante et apporter une petite mise à jour au nouveau flux.

Dupliquer le flux

1. Accédez à la page Flows dans la vue du projet de connecteur.
2. Dupliquer l’action Current.
   • En mode liste, cliquez sur ⚙️ > Dupliquer.
   • Dans la vue des cartes, cliquez sur Duplicate dans le coin inférieur droit de la carte.
3. Ouvrez le nouveau flux et renommez-le en Forecast.
4. Entrez Cette action renvoie une prévision météo sur 5 jours pour une ville. pour la Description.
5. Cliquez sur Save.

Mettre à jour le point de terminaison de l’API

1. Mettez à jour le champ relative_URL de /data/2.5/weather à /data/2.5/forecast dans la carte Flow Control – Call Flow.
2. Enregistrer le flux.

Tester le flux

Testez le flux si vous le souhaitez.

Créer une action pour l'action API personnalisée

Dans cette section, vous allez créer une action pour l’action API personnalisée.

Une action d'API personnalisée permet d'appeler n'importe quel point de terminaison sur le service, même si une action prédéfinie n'est pas disponible. Une action d'API personnalisée vous permettra de spécifier le point de terminaison de l'API, la méthode de requête (GET, POST, etc.) et les paramètres de requête (query, headers et body).

L’article Comprendre les connecteurs Okta Workflows contient des informations sur une action API personnalisée.

Créer un flow

Depuis l'onglet Flows :

1. Cliquez sur + New Flow pour créer un nouveau flux.
2. Cliquez sur Unnamed dans le coin supérieur gauche pour nommer le flux.
3. Entrez Custom API Action pour le Flow name.
4. Saisissez Effectuer une requête HTTP authentifiée à l’API OpenWeather. pour la Description.
5. Cochez l'option Save all data that passes through the Flow? option
6. Cliquez sur Enregistrer pour enregistrer le flux.

Configurer les entrées d'action

1. Cliquez sur Ajouter un événement et choisissez l'événement Action.

Une action API personnalisée doit prendre en charge les types de requêtes pris en charge par l'API sous-jacente.

1. Cliquez sur Add Options dans la section OPTIONS.
2. Cliquez sur Add field.
3. Saisissez Type de requête pour le champ Label.
4. Remplacez Field Type par Dropdown.

Saisissez les valeurs pour le type de demande :

1. Saisissez GET pour Option et GET pour Value dans la première ligne.
2. Entrez le reste des types de requêtes :
   • POST
   • PUT
   • PATCH
   • Supprimer
3. Vérifiez GET comme option par défaut.
4. Cliquez sur Appliquer pour enregistrer la liste des types de requêtes.

Remarque : L'API OpenWeather utilise le type de requête GET. D'autres connecteurs que vous créerez prendront probablement en charge davantage de types de requêtes.

Configuration de la liste des types de demandes.

L'action a besoin d'autres entrées : URL relative, en-têtes, champs de requête et de corps.

1. Cliquez sur Add Inputs dans la section INPUTS.
2. Cliquez sur Ajouter un groupe > Ajouter un groupe statique.
3. Ajoutez les champs suivants :
   • Relative URL (type Texte, champ obligatoire).
   • Query (Objet).
   • Headers (Objet).
   • Corps (Objet).

Les entrées ressemblent à ceci :

Entrées d’action d’API personnalisée.

4. Cliquez sur Apply pour enregistrer les modifications.

Le flux ressemble à ceci :

Action d’API personnalisée avec des entrées.

Le flux a toutes les entrées. Dans la section suivante, vous appellerez le point de terminaison de l'API.

Appelez l'endpoint d'API personnalisé

1. Cliquez sur Ajouter une fonction.
2. Ajoutez la fonction Call Flow.
3. Cliquez sur Choose Flow et sélectionnez le flux httpHelper.
4. Cliquez sur Choisir.
5. Créez les connexions à la carte Call Flow dans la capture d’écran ci-dessous :

Transmettre des données à la carte Call Flow.

Faites défiler jusqu'à la section de sortie de la carte Call Flow.

1. Créez les trois champs de sortie suivants :
   • statusCode (type Nombre).
   • headers (Objet).
   • body (Objet).

Créer des sorties d’action

1. Cliquez sur Add Outputs sur la carte Return Outputs.
2. Cliquez sur Add group > Add static group.
3. Ajoutez trois champs de sortie :
   • Code d'état (type Number).
   • Headers (Objet).
     • Supprimez l'entrée de clé vide.
   • Body (Objet).
     • Supprimez l'entrée de clé vide.
4. Cliquez sur Appliquer.
5. Créez les connexions à la carte Return Outputs dans la capture d'écran ci-dessous :

Configuration de la sortie du flux.

Tester le flux

Le connecteur n'a pas d'action pour l'API de géocodage. Vous pouvez utiliser le point de terminaison de géocodage pour tester l'action API personnalisée.

Pour tester le flux:

1. Cliquez sur Exécuter pour tester le flux.
2. Entrez GET pour Request Type.
3. Saisissez /geo/1.0/direct pour le champ Relative URL.
4. Entrez {"q": "Rome,IT"} pour le champ query.
5. Cliquez sur Exécuter pour tester le flux.

Vous avez ajouté Forecast et l'Custom API Action au connecteur. Vous devez déployer les modifications.

Déployer le connecteur

Activer les flux

1. Revenez à la page Flow et activez tous les flux.

Déploiement

1. Retournez à l'onglet Deployment.
2. Cliquez sur Create test version pour créer une nouvelle version du connecteur.
3. Cliquez sur les trois points verticaux > Deploy Version.

Déploiements du connecteur.

Utilisez les nouvelles actions de connecteur dans un flux

1. Revenez à Workflows et ouvrez un flux que vous avez déjà utilisé.
2. Ajoutez la carte Weather – Forecast et la carte Weather – Custom API Action.
3. Tester le flux.

Test des actions du connecteur.

Beau travail

Félicitations !

Vous avez créé un connecteur avec trois actions pour l'API OpenWeather dans le Connector Builder d'Okta Workflows.

Ressources

📚 Building a Custom Connector in Okta Workflows, a Video Series.

📖 Documentation Okta Workflows Connector Builder.

🍫 Obtenez de l'aide auprès de spécialistes Workflows pendant les heures de bureau communautaires hebdomadaires.

📺 Apprenez grâce aux vidéos Workflows.

🛟 Obtenez de l'aide auprès du support : discutez d'un sujet Workflows ou posez une question.

🙋🏻‍♀️ Obtenez de l'aide de la communauté : rejoignez le canal #okta-workflows sur MacAdmins Slack.