Créer un API de tâche (API de tâche en formulaire)

Créez un API de tâche avec les packages disponibles dans la Control Room dans l'éditeur API de tâche. Vous pouvez créer un API de tâche avec des actions provenant de packages pris en charge sur Automation 360 Cloud.

Prérequis

Vous devez disposer d'une licence Bot Creator.
Dans cette rubrique, nous vous expliquons comment créer une API de tâche à l'aide d'une API qui prend en entrée un code postal aux États-Unis et renvoie en sortie les noms Lieu et État. Vous pouvez créer un API de tâche avec les actions propres à votre cas d'utilisation.

Procédure

  1. Connectez-vous à votre instance de la Automation Anywhere Control Room en tant que Bot Creator.
  2. Créez une API de tâche :
    1. Dans le volet de gauche, cliquez sur Automatisation.
    2. Cliquez sur Créer un nouveau > Tâche API.
    3. Dans la fenêtre Créer une tâche API, saisissez le nom du API de tâche.
    4. Acceptez l'emplacement du dossier par défaut : \Bots\.
      Pour modifier l'emplacement de stockage de votre API de tâche, cliquez sur Choisir, puis suivez les invites.
    5. Cliquez sur Créer et modifier.
  3. Créez une variable ZipCode comme entrée qui sera utilisée dans l'URL du code postal.
  4. Utilisez l'action Méthode Get pour récupérer le Lieu et l'État d'un code postal.
    Remarque : Des packages prédéfinis sont disponibles pour la plupart des applications d'entreprise courantes. Pour une liste des packages pris en charge, consultez FAQ sur les tâches de l'API (contenu .30).
    1. Double-cliquez sur l'action Services Web REST > Méthode Get ou faites-la glisser.
      Services Web Rest - Méthode Get
    2. Saisissez l'URI suivant. $ZipCode$ dans l'URI correspond à la variable d'entrée créée à l'étape 3. 
      https://api.zippopotam.us/us/$ZipCode$
      Remarque :

      Vous pouvez appeler plusieurs API dans le cadre d'une API de tâche unique. Cela peut simplifier votre automatisation et réduire la nécessité d'effectuer plusieurs tâches distinctes. Par exemple, vous pouvez appeler l'API 1 pour récupérer des données sur les produits, l'API 2 pour récupérer des données sur les prix, puis l'API 3 pour créer un devis dans le cadre de la même API de tâche.

    3. Dans la liste déroulante Mode d'authentification, sélectionnez Aucune authentification, car ce point de terminaison ne nécessite pas d'authentification.
      Remarque : En général, les points de terminaison nécessitent une authentification pour garantir que seules les applications autorisées peuvent accéder aux données. Sélectionnez un mécanisme d'authentification approprié pour autoriser le point de terminaison auquel vous souhaitez accéder.
    4. Créez la variable pDictZipCodeApiResponse dans le champ Attribuer la sortie à une variable. Pour en savoir plus sur la création d'une variable, consultez la rubrique Création d'une variable.
      Remarque :
      • La réponse JSON complète de l'API est attribuée à cette variable du dictionnaire : pDictZipCodeApiResponse.
      • Les types de variables suivants ne sont pas pris en charge pour les Tâches API : Fichier, Fenêtre et Formulaire.
  5. Dans le volet Actions, faites glisser l'action JSON > Démarrer une session dans le canevas sous l'action Services Web REST.
    1. Dans le champ Source de données, sélectionnez Texte et saisissez $pDictZipCodeApiResponse{Body}$.
    2. Dans le champ Session d'objet JSON, sélectionnez Session locale et saisissez Default.

      Dictionnaire des tâches API
      Vous disposez maintenant de l'ensemble du Body. La tâche suivante consiste à extraire les champs obligatoires du corps. Voici un exemple de JSON Body :
      {
    "post code": "90210",
    "country": "United States",
    "country abbreviation": "US",
    "places": [
        {
            "place name": "Beverly Hills",
            "longitude": "-118.4065",
            "state": "California",
            "state abbreviation": "CA",
            "latitude": "34.0901"
        }
    ]
}
  6. Extrayez le place name du JSON.
    1. Dans le volet Actions, faites glisser l'action Json > Obtenir la valeur du nœud dans le canevas, sous l'action Json > Session État.
    2. Spécifiez les nœuds à extraire. Par exemple, pour extraire le lieu, vous pouvez utiliser places[0].["place name"]
    3. Créez une variable Lieu et attribuez la sortie à cette variable.
  7. Extrayez le state du JSON.
    1. Dans le volet Actions, faites glisser l'action Json > Obtenir la valeur du nœud dans le canevas, sous l'action Json > Session État.
    2. Spécifiez les nœuds à extraire. Par exemple, pour extraire le lieu, vous pouvez utiliser places[0].["state"]
    3. Créez une variable État et attribuez la sortie à cette variable.
  8. Cliquez sur Enregistrer.
    Pour tester le API de tâche, cliquez sur le Débogueur. Pendant le débogage, le périphérique local est utilisé pour exécuter le API de tâche. Le API de tâche créé dans cet exemple récupère les valeurs Lieu et État pour tout code postal saisi.