Point de terminaison en temps réel pour la API de tâche

Invoquez instantanément les Tâches API avec un point de terminaison en temps réel. Vous pouvez générer une URL d'exécution de API de tâche avec un jeton pour lancer l'exécution d'une API de tâche par le biais d'un point de terminaison d'API.

Principaux avantages

  • Déploiement programmatique : invoquez la API de tâche en temps réel où que vous soyez à l'aide de votre client API préféré.
  • Temps de réponse : conçu pour une faible latence avec des taux de réponse en temps quasi réel, il vise à fournir des réponses presque instantanément (généralement en quelques millisecondes).
  • Traitement :
    • Les automatisations sont chargées dans le cloud et prêtes à accepter des demandes à tout moment. Cela permet un traitement et une réponse rapides.
    • La licence Premium permet de faire évoluer votre automatisation et d'accéder à un plus grand pool de ressources cloud qui peuvent exécuter plusieurs instances de votre API de tâche, en augmentant la concurrence et en vous permettant de traiter plus de demandes de API de tâche simultanément.
  • Cas d'utilisation :
    • Idéal pour les environnements interactifs tels que les chatbots
    • Détection des fraudes en temps réel
    • Créations de cas en ligne
    • ou tout autre cas d'utilisation où une réponse instantanée est cruciale

Prérequis

Les exemples de code suivants vous fournissent une procédure pour déployer une API de tâche en temps réel sur un périphérique dans le cloud. Vous pouvez également transmettre des variables aux Tâches API lorsqu'ils sont déployés.

Étape 1 : Point de terminaison en temps réel pour la API de tâche
authentifiez l'accès à votre instance de la Control Room.
Étape 2 : Point de terminaison en temps réel pour la API de tâche
un administrateur peut créer une allocation de API de tâche.
Étape 3 : Point de terminaison en temps réel pour la API de tâche
un administrateur peut dresser la liste de toutes les allocations de API de tâche.
Étape 4 : Point de terminaison en temps réel pour la API de tâche
générez l'URL et le jeton pour déployer votre API de tâche.
Étape 5 : Point de terminaison en temps réel pour la API de tâche
exécutez votre API de tâche avec l'URL unique générée avec le jeton.

Authentifier

Authentifiez-vous pour accéder à votre environnement. Il s'agit généralement de jetons d'accès ou de clés API.

POST https://{{ControlRoomURL}}v1/authentication
Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<b
earer token>>

Il existe deux flux d'authentification distincts pour interagir avec le point de terminaison en temps réel de la tâche API :

1. Authentification du développeur de robots (exécution de la API de tâche) :

ce flux permet aux développeurs de robots de générer une URL et un jeton (Point de terminaison en temps réel pour la API de tâche) pour exécuter une API de tâche (Point de terminaison en temps réel pour la API de tâche).

Tous les appels d'API doivent contenir soit un jeton d'authentification de l'API d'authentification (qui génère un JSON Web Token), soit un Bearer token des services OAuth. Vous ne pouvez pas utiliser les deux ensemble dans une API.

2. Authentification de l'administrateur (allocation de la API de tâche) :

cette authentification est nécessaire pour que les administrateurs puissent allouer (Point de terminaison en temps réel pour la API de tâche) la API de tâche dans le cloud, de sorte qu'un développeur de robots puisse exécuter la API de tâche.

Créer une allocation de API de tâche (administrateur)

Remarque : Vous devez disposer de droits d'administrateur pour créer une allocation de API de tâche.

Une fois qu'une API de tâche est archivée, vous pouvez ajouter la API de tâche au cloud. Ce point de terminaison d'API ajoute la API de tâche au cloud et crée une allocation de ressources exécuter votre API de tâche. Consultez la rubrique Ajouter une tâche API au cloud correspondante qui détaille l'allocation de API de tâche au sein de la Control Room. L'allocation de API de tâche se fait après la création d'une API de tâche. Pour en savoir plus sur la création d'une API de tâche, consultez la rubrique Créer un API de tâche (API de tâche en formulaire).

PUT https://{{ControlRoomURL}}orchestrator/v1/hotbot/config/create
Corps de la demande :
{
  "fileId": "5",
  "runAsUserOrNone": 3,
  "concurrencyLimit": 2
}
Réponse :
{
  "fileId": "5",
  "runAsUserOrNone": 3,
  "concurrencyLimit": 2
}
Paramètres de la demande/de la réponse
Paramètre Type Obligatoire Description
fileId Entier Oui

ID de l'automatisation à déployer.
runAsUserOrNone Entier Non apitaskrunner pour établir le contexte RunAsUser pour les Tâches API. Pour en savoir plus sur apitaskrunner, consultez la rubrique Utilisateur Exécuter en tant que pour les tâches API (apitaskrunner).
Remarque : Cet utilisateur RunAsUser ne nécessite pas de licence Bot Runner.
concurrencyLimit Entier Non Nombre maximum de tâches API simultanées à exécuter pour une demande (hotbot) en temps réel donnée.

(Facultatif) Répertorier l'allocation de API de tâche (administrateur)

Remarque : Vous devez disposer de droits d'administrateur pour répertorier l'allocation de Tâches API.

Ce point de terminaison d'API répertorie toutes les allocations de Tâches API au sein de votre Control Room. Vous pouvez confirmer si une API de tâche particulière est ajoutée à la liste d'allocation de API de tâche avant de générer l'URL d'exécution de la tâche API avec le jeton.

POST https://orchestrator/v1/hotbot/config
Corps de la demande :
{
  "page": {
    "offset": 0,
    "length": 100
  }
}
Paramètres de la demande
Paramètre Type Obligatoire Description
page objet Non object (PageRequest)

Règles de pagination, permettant de filtrer en fonction de la page souhaitée
décalage Entier Non Index de début de page.
longueur Entier Non Longueur de la page.
Réponse :
{
    "list": [
        {
            "fileId": "149",
            "filePath": "Automation Anywhere\\Bots\\Zip Code API Task",
            "fileName": "Zip Code API Task",
            "runAsUserOrNone": "12",
            "concurrencyLimit": 1
        },
        {
            "fileId": "180",
            "filePath": "Automation Anywhere\\Bots\\API_task_String 01 1708025672.bot",
            "fileName": "API_task_String 01 1708025672.bot",
            "runAsUserOrNone": "12",
            "concurrencyLimit": 3
        },
        {
            "fileId": "184",
            "filePath": "Automation Anywhere\\Bots\\API_task_Rest 01 1708026445.bot",
            "fileName": "API_task_Rest 01 1708026445.bot",
            "runAsUserOrNone": "12",
            "concurrencyLimit": 5
        }
    ],
    "page": {
        "offset": 0,
        "total": 3,
        "totalFilter": 3
    }
}
Paramètres de réponse
Paramètre Type Description
fileId Entier

ID des automatisations.
filePath Chaîne Chemin de fichier des automatisations.
fileName Chaîne Nom de fichier des automatisations.
runAsUserOrNone Entier apitaskrunner pour établir le contexte RunAsUser pour les Tâches API. Pour en savoir plus sur apitaskrunner, consultez la rubrique Ajouter une tâche API au cloud.
concurrencyLimit Entier Nombre maximum de tâches API simultanées à exécuter pour une demande (hotbot) en temps réel donnée.

Générer l'URL/le jeton d'exécution de la tâche

Ce point de terminaison d'API génère l'URL et le jeton d'exécution de la tâche avec lesquels vous pourrez déployer une API de tâche.

POST https://orchestrator/v1/hotbot/config/accessdetails
Corps de la demande :
{
  "botRepositoryPath": [
    "Automation Anywhere\\Bots\\My-API-Task"
  ]
}
Paramètres de la demande
Paramètre Type Obligatoire Description
botRepositoryPath Chaîne Oui Chemin du référentiel de la API de tâche.
Réponse :
{
  "accessDetails": {
    "Automation Anywhere\\Bots\\My-API-Task": {
      "url": "https://hotbot-2689-knative-0a665343-88e9-17be-8189-936dad5d0144.prod-ause1-ee.my.automationanywhere.digital/execute",
      "headers": {
        "X-Authorization": "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIzODAiLCJ0ZW5hbnRVdWlkIjoiMGE2NjUzNDMtODhlOS0xN2JlLTgxODktOTM2ZGFkNWQwMTQ0IiwiY2xpZW50VHlwZSI6IldFQiIsIm11bHRpcGxlTG9naW4iOnRydWUsImJvdElkIjoyNjg5LCJpYXQiOjE3MDgzNTIxOTgsImV4cCI6MTcwODM5NTM5OCwiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjI5OTg3MDkyNzIxNjc5MH0.p8xsnlec7-ZbPJBfDDk1Wq0k8RqAzzsL6bK7BOtLp_jY1NgQvdAO5Yra647-94JV2cY8Vbe5H7zObia3S9oQ9dFXrnmSSSYs3_x7e_-vkaNcwx1Ev3J7lymqnH8Xc73s-TTGyebRlXiI714Ii62DJ_vKBEUvNM47V0H1FQk6xIfpzJAMMDRFZWO3MUvowgD4L-O6xre0RLapCYOSVtH_0CbM0VBfNkuwDAnF1kQeCtpWIvv_nETy7A-UdSox9GqtDp9h2Elkl-v3KJ8kEru7qT4fWZlsuzFPL7XzqkALCP39N7fxOpzlCfHYGPooLRHcFLGIPxpqi1bkfsn-Xk2BfQ"
      }
    }
  },
  "errors": {
  }
}
Paramètres de réponse
Paramètre Type Description
url Chaîne

URL - Il s'agit du point de terminaison du conteneur pour la prochaine demande de déploiement de votre API de tâche.
X-Authorization Chaîne Contient le jeton que vous devez fournir dans les en-têtes au format X-Authorization.
Remarque :

Après avoir généré l'URL d'exécution de la API de tâche ainsi que les en-têtes nécessaires à l'exécution de la API de tâche, vous pouvez envoyer une demande de déploiement via l'URL générée. Si vous spécifiez des entrées, veillez à ce que la variable de l'automatisation soit marquée comme entrée pour que celle-ci puisse recevoir les valeurs mappées. De plus, le nom de la variable dans l'automatisation doit correspondre à la valeur qui est mappée dans le corps de la demande.

Exécuter la API de tâche

Exécutez votre API de tâche avec l'URL unique générée avec le jeton.

POST https://hotbot-2689-knative-0a665343-88e9-17be-8189-936dad5d0144.prod-ause1-ee.my.automationanywhere.digital/execute
Header: X-Authorization: eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIzODAiLCJ0ZW5hbnRVdWlkIjoiMGE2NjUzNDMtODhlOS0xN2JlLTgxODktOTM2ZGFkNWQwMTQ0IiwiY2xpZW50VHlwZSI6IldFQiIsIm11bHRpcGxlTG9naW4iOnRydWUsImJvdElkIjoyNjg5LCJpYXQiOjE3MDgzNTIxOTgsImV4cCI6MTcwODM5NTM5OCwiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjI5OTg3MDkyNzIxNjc5MH0.p8xsnlec7-ZbPJBfDDk1Wq0k8RqAzzsL6bK7BOtLp_jY1NgQvdAO5Yra647-94JV2cY8Vbe5H7zObia3S9oQ9dFXrnmSSSYs3_x7e_-vkaNcwx1Ev3J7lymqnH8Xc73s-TTGyebRlXiI714Ii62DJ_vKBEUvNM47V0H1FQk6xIfpzJAMMDRFZWO3MUvowgD4L-O6xre0RLapCYOSVtH_0CbM0VBfNkuwDAnF1kQeCtpWIvv_nETy7A-UdSox9GqtDp9h2Elkl-v3KJ8kEru7qT4fWZlsuzFPL7XzqkALCP39N7fxOpzlCfHYGPooLRHcFLGIPxpqi1bkfsn-Xk2BfQ
Corps de la demande :
{
   "botInput":{
      "iStrZipCode":{
         "type":"STRING",
         "string":"76131"
      }
   }
}
Paramètres de la demande
Paramètre Type Obligatoire Description
Objet botInput
type N'importe lequel Non Par défaut, il s'agit de STRING. Les valeurs possibles pour le type incluent : STRING, NUMBER, BOOLEAN, FILE, ITERATOR, LIST, DICTIONARY, TABLE, VARIABLE, CONDITIONAL, WINDOW, TASKBOT, DATETIME, UIOBJECT, RECORD, EXCEPTION, CREDENTIAL, COORDINATE, IMAGE, REGION, PROPERTIES, TRIGGER, CONDITIONALGROUP, FORM, FORMELEMENT, HOTKEY, and WORKITEM.
Réponse :
{
   "hotBotResult":{
      "botOutput":{
         "State":{
            "type":"STRING",
            "string":"California"
         },
         "Place":{
            "type":"STRING",
            "string":"San Jose"
         }
      }
   }
}
Paramètres de réponse
Paramètre Type Description
hotBotResult Objet

Objet contenant la sortie de la API de tâche.