Point de terminaison à la demande pour les API Task
- Dernière mise à jour2025/07/01
Point de terminaison à la demande pour les API Task
Appelez des API Tasks instantanément avec un point de terminaison. Cela permet de lancer et d\'exécuter dynamiquement des API Tasks à la demande à l\'aide de l\'API de déploiement. Cette approche permet de rationaliser les flux de travail et d\'améliorer l\'efficacité des ressources par rapport aux déploiements statiques traditionnels.
Principaux avantages
- Déploiement programmatique : déployez une API Task de n\'importe où et à la demande à l\'aide de votre client API préféré.
-
Traitement :
- Les automatisations ne sont activées qu\'en cas de besoin, ce qui garantit une utilisation optimale des ressources. Cela signifie qu\'elles ne sont pas constamment déployées dans le cloud, préservant ainsi des ressources. Au lieu de cela, elles sont chargées et exécutées à chaque demande.
- En période de forte affluence, les automatisations sont placées dans une file d\'attente et exécutées dès que les périphériques sont disponibles, ce qui garantit des opérations fluides même en cas de forte charge. Vous pouvez consulter la progression des automatisations sur la page Activité.
- 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 Task, en augmentant la concurrence et en vous permettant de traiter plus de demandes de API Task simultanément.
-
Cas d\'utilisation actuels :
- Traitements par lots (analyse des données de vente, génération de rapports, etc.)
- Tâches planifiées
- Situations où une réponse immédiate n\'est pas indispensable
Authentifier
Obtenez les informations d\'authentification nécessaires pour interagir avec l\'API de déploiement. Il s\'agit généralement de jetons d\'accès ou de clés API. L\'exemple suivant déploie une API Task à la demande sur un périphérique cloud. Vous pouvez également transmettre des variables aux robots lorsqu\'ils sont déployés.
POST https://{{ControlRoomURL}}/v4/automations/deployHeader: X-Authorization: <<authentication token>> or Authorization: Bearer <<b
earer token>>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.
Composer la demande à la demande
{
"botId": 121,
"automationName": "SAMPLE_APITASK",
"description": "My first API Task deploy using api",
"botLabel": "string",
"executionType": "RUN_NOW",
"automationPriority": "PRIORITY_MEDIUM",
"headlessRequest": {
"numberOfExecutions": 1,
"queueOnSlotsExhaustion": false,
"sharedRunAsUserId": 12
},
"botInput": {
"inputVar": {
"type": "STRING",
"string": "PassingString"
}
}
}Les demandes de déploiements d\'automatisations peuvent être faites sans aucun champ d\'entrée. Si vous spécifiez des entrées, veillez à ce que la variable de l\'automatisation soit marquée comme entrée pour que la API Task puisse recevoir ces valeurs mappées. De plus, le nom de la variable dans la API Task doit correspondre à la valeur mappée dans le corps de la demande.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| botId | Entier | Oui | Saisissez l\'ID de l\'automatisation à déployer. L\'ID est visible dans la barre d\'adresse lorsque vous ouvrez l\'automatisation dans un éditeur. |
| automationName | Chaîne | Non | Saisissez le nom que vous avez utilisé lorsque vous avez créé l\'automatisation. |
| description | Chaîne | Non | Saisissez la description que vous avez utilisée lors de la création de l\'automatisation. |
| botLabel | Chaîne | Non | Saisissez l\'étiquette que vous avez appliquée lorsque vous avez archivé l\'automatisation. Vous pouvez saisir Production ou N/A. |
| executionType | Chaîne | Non | Saisissez le type d\'exécution associé au robot. Vous pouvez saisir l\'un des types d\'exécution suivants :
|
| automationPriority | Chaîne | Non | Saisissez la priorité d\'exécution de l\'automatisation. Vous pouvez saisir l\'une des priorités suivantes :
PRIORITY_MEDIUM. |
| Objet headlessRequest. | |||
| numberOfExecutions | Entier | Non | Entrez le nombre d\'exécutions à effectuer pour une requête à la demande spécifique (sans interface). |
| queueOnSlotsExhaustion | booléen | Non | Entrez True ou False pour indiquer si le déploiement doit être mis en file d\'attente. |
| sharedRunAsUserId | Entier | Non | Saisissez l\'identifiant utilisateur de l\'utilisateur apitaskrunner afin d\'établir le contexte RunAsUser pour les API Tasks. L\'identifiant utilisateur est visible dans la barre d\'adresse lorsque vous modifiez les détails de l\'utilisateur sur la page Modifier l\'utilisateur. Pour en savoir plus sur apitaskrunner, consultez la rubrique Utilisateur Exécuter en tant que pour API Task (apitaskrunner).Remarque : Le RunAsUser ne nécessite pas de licence Bot Runner.
|
| Objet botInput | |||
| type | N\'importe lequel | Non | Saisissez le type de la variable d\'entrée. Vous pouvez saisir l\'un des types de variables suivants : |
| chaîne | Chaîne | Non | Saisissez la chaîne qui doit être utilisée comme entrée pour la variable STRING. |
{
"deploymentId": "320a2149-aa44-41ab-af9b-f9343ae2581b",
"automationName": "SAMPLE_APITASK"
}| Paramètre | Type | Description |
|---|---|---|
| deploymentId | Chaîne | L\'identifiant de déploiement qui est généré lors du déploiement de robots. |
| automationName | Chaîne | Nom de l\'automatisation déployée. Si vous n\'incluez pas le nom de l\'automatisation dans la requête, un nom aléatoire est assigné à l\'automatisation déployée. |
/swagger/ à la fin de l\'URL. https://{{ControlRoomURL}}/swagger/
Consultez la page d\'activité de votre Control Room pour suivre la progression de votre exécution à la demande (sans interface) depuis Mis en file d\'attente >> En cours >> Terminé.
Pour plus de détails sur l\'API de déploiement, consultez API de déploiement de robots (V4).