Automation 360

Extremo de Tarea API en tiempo real

Descargar como PDF

Comentarios

Contenidos

Índice

Extremo de Tarea API en tiempo real

Descargar como PDF

Comentarios

Actualizado: 2024/04/17

Extremo de Tarea API en tiempo real

Llame a Tareas API de manera instantánea con un extremo en tiempo real. Puede generar una URL de ejecución de Tarea API junto con un token para iniciar una ejecución de Tarea API a través de un extremo de API.

Beneficios clave

Despliegue programático: Llame a Tarea API desde cualquier lugar en tiempo real con su cliente API preferido.
Tiempo de respuesta: Diseñado para una baja latencia con tasas de respuesta casi en tiempo real, con el objetivo de proporcionar respuestas prácticamente instantáneas, que suelen ser en milisegundos.
Procesamiento:
- Las automatizaciones se cargan en la nube y están listas para aceptar solicitudes en todo momento. Esto permite un procesamiento y una respuesta rápidos.
- La licencia prémium ayuda a aumentar la escala de su automatización y brinda acceso a un conjunto más grande de recursos en la nube que pueden ejecutar varias instancias de su Tarea API, lo cual impulsa la concurrencia y le permite gestionar más solicitudes de Tarea API simultáneamente.
Casos de uso:
- Ideal para situaciones interactivas, como bots de charla.
- Detección de fraude en tiempo real.
- Creaciones de casos en línea.
- Cualquier caso de uso en el que la respuesta instantánea sea crucial.

Requisitos previos

Asegúrese de crear su Tarea API. Para obtener más detalles sobre la creación de Tarea API, consulte Crear una Tarea API (Tarea API en un formulario).
Primero debe registrar su Tarea API. Para obtener más detalles sobre cómo registrar su Tarea API, consulte Registrar una tarea API en el repositorio.

Los siguientes fragmentos de código de muestra le proporcionan un procedimiento para implementar un Tarea API en tiempo real en un dispositivo en la nube. También puede pasar variables a Tareas API cuando se implementan.

Paso 1: Extremo de Tarea API en tiempo real: Debe autenticar el acceso a la instancia de la Control Room.
Paso 2: Extremo de Tarea API en tiempo real: Un administrador puede crear una asignación de Tarea API.
Paso 3: Extremo de Tarea API en tiempo real: Un administrador puede enumerar todas las asignaciones de Tarea API.
Paso 4: Extremo de Tarea API en tiempo real: Genere la URL y el token para implementar su Tarea API.
Paso 5: Extremo de Tarea API en tiempo real: Ejecute su Tarea API con la URL única generada junto con el token.

Autenticar

Debe realizar la autenticación para obtener acceso a su entorno. Esto suele implicar tokens de acceso o claves de API.

POST https://{{ControlRoomURL}}v1/authentication

Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<b
earer token>>

Hay dos flujos de autenticación distintos para interactuar con el extremo de la tarea API en tiempo real:

1 Autenticación del desarrollador de bots (ejecución de Tarea API):

Este flujo permite que los desarrolladores de bots generen una URL y un token (Extremo de Tarea API en tiempo real) para ejecutar una Tarea API (Extremo de Tarea API en tiempo real).

Todas las llamadas a la API deben contener un token de autenticación de la API de autenticación (genera un token web JSON) o un token de portador de los servicios OAuth. No se pueden utilizar ambos a la vez en una API.

2 Autenticación del administrador (asignación de Tarea API):

Esta autenticación se necesita para que los administradores asignen (Extremo de Tarea API en tiempo real) la Tarea API en la nube, para que un desarrollador de bot pueda ejecutar la Tarea API.

Crear una asignación de Tarea API (administrador)

Nota: Necesita derechos de administrador para crear una asignación de Tarea API.

Después de registrar la Tarea API, puede agregar la Tarea API a la nube. Este extremo de API agrega la Tarea API a la nube y crea una asignación de recursos para ejecutar su Tarea API. La sección correspondiente que detalla la asignación de la Tarea API dentro de la Control Room es Agregar una tarea API a la nube. La asignación de la Tarea API se realiza después de crear una Tarea API. Para obtener más información sobre la creación de Tarea API, consulte Crear una Tarea API (Tarea API en un formulario).

PUT https://{{ControlRoomURL}}orchestrator/v1/hotbot/config/create

Cuerpo de la solicitud:

{
  "fileId": "5",
  "runAsUserOrNone": 3,
  "concurrencyLimit": 2
}

Respuesta:

{
  "fileId": "5",
  "runAsUserOrNone": 3,
  "concurrencyLimit": 2
}

Parámetros de respuesta o solicitud


Parámetro	Tipo	Obligatorio	Descripción
fileId	Entero	Sí	ID de la automatización que se implementará.
runAsUserOrNone	Entero	No	El apitaskrunner para establecer el contexto RunAsUser para Tareas API. Para obtener más información sobre apitaskrunner, consulte Usuario de ejecución para la tarea API (apitaskrunner). Nota: Este RunAsUser no requiere una licencia de Bot Runner.
concurrencyLimit	Entero	No	Cantidad máxima de simultaneidad que se ejecutará para una solicitud determinada en tiempo real (hotbot).

Lista de asignación de Tarea API del administrador (opcional)

Nota: Necesita derechos de administrador para enumerar la asignación de la Tareas API.

Este extremo de API enumera todas las asignaciones de las Tareas API dentro de su Control Room. Puede confirmar si una Tarea API en particular se agrega a la lista de asignación de la Tarea API antes de proceder a generar la URL de ejecución de las tareas API con token.

POST https://orchestrator/v1/hotbot/config

Cuerpo de la solicitud:

{
  "page": {
    "offset": 0,
    "length": 100
  }
}

Parámetros de solicitud


Parámetro	Tipo	Obligatorio	Descripción
página	objeto	No	`object (PageRequest)` Reglas de paginación: le permite filtrar según la página deseada.
compensación	Entero	No	Índice de inicio de página.
length	Entero	No	Longitud de la página.

Respuesta:

{
    "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
    }
}

Parámetros de respuesta


Parámetro	Tipo	Descripción
fileId	Entero	ID de las automatizaciones.
filePath	Cadena	La ruta del archivo de las automatizaciones.
Nombre de archivo	Cadena	El nombre de archivo de las automatizaciones.
runAsUserOrNone	Entero	El apitaskrunner para establecer el contexto RunAsUser para Tareas API. Para obtener más información sobre apitaskrunner, consulte Agregar una tarea API a la nube.
concurrencyLimit	Entero	Cantidad máxima de simultaneidad que se ejecutará para una solicitud determinada en tiempo real (hotbot).

Generar URL o token de ejecución de tarea

Este extremo de API genera una URL de ejecución de tareas y un Token con el que podrá implementar una Tarea API.

POST https://orchestrator/v1/hotbot/config/accessdetails

Cuerpo de la solicitud:

{
  "botRepositoryPath": [
    "Automation Anywhere\\Bots\\My-API-Task"
  ]
}

Parámetros de solicitud


Parámetro	Tipo	Obligatorio	Descripción
botRepositoryPath	Cadena	Sí	Ruta del repositorio de la Tarea API.

Respuesta:

{
  "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": {
  }
}

Parámetros de respuesta


Parámetro	Tipo	Descripción
dirección url	Cadena	URL: este es el extremo del contenedor de la próxima solicitud para implementar su Tarea API.
Autorización-X	Cadena	Contiene el token que debe utilizar en los encabezados como `X-Authorization`.

Nota:

Una vez que genere la URL de ejecución de la Tarea API, además de los encabezados que necesita para ejecutar la Tarea API, puede enviar las solicitudes de implementación a través de la URL generada. Si especifica entradas, asegúrese de que la variable de la automatización esté marcada como entrada para que reciba estos valores asignados correctamente. Además, el nombre de la variable en la automatización tiene que coincidir con el valor que se está asignando en el cuerpo de la solicitud.

Ejecutar Tarea API

Ejecuta su Tarea API con la URL única que se generó junto con el token.

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

Cuerpo de la solicitud:

{
   "botInput":{
      "iStrZipCode":{
         "type":"STRING",
         "string":"76131"
      }
   }
}

Parámetros de solicitud


Parámetro	Tipo	Obligatorio	Descripción
Objeto botInput
tipo	Cualquiera	No	Por defecto es `STRING`. Algunos valores posibles para tipo son los siguientes: `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.`:

Respuesta:

{
   "hotBotResult":{
      "botOutput":{
         "State":{
            "type":"STRING",
            "string":"California"
         },
         "Place":{
            "type":"STRING",
            "string":"San Jose"
         }
      }
   }
}

Parámetros de respuesta


Parámetro	Tipo	Descripción
hotBotResult	Objeto	Objeto que contiene la salida de la Tarea API.

¿Este tema le resultó útil?

Me gusta No me gusta