Endpoint de Tarefa de API em tempo real
- Atualizado: 2024/04/04
Endpoint de Tarefa de API em tempo real
Chamar Tarefas de API de modo instantâneo com um endpoint em tempo real. Você pode gerar um URL de execução de Tarefa de API junto com um token para iniciar uma execução de Tarefa de API por meio de um endpoint de API.
Principais benefícios
- Implantação programática: Chame uma Tarefa de API de qualquer lugar, em tempo real, usando a API cliente de sua preferência.
- Tempo de resposta: Projetado para baixa latência com taxas de resposta quase em tempo real, com o objetivo de fornecer respostas quase de modo instantâneo (em geral, em milissegundos).
- Processamento:
- As automações são carregadas na nuvem e estão prontas para aceitar solicitações a qualquer momento. Isso permite processamento e resposta rápidos.
- A licença Premium ajuda a dimensionar as automações, além de fornece acesso a um conjunto maior de recursos de nuvem capazes de executar várias instâncias da Tarefa de API, o que não só aumenta a simultaneidade mas também permite que você processe mais Tarefa de API solicitações de maneira concomitante.
- Casos de uso:
- Ideal para situações interativas como chatbots
- detecção de fraude em tempo real
- Criações de casos on-line
- ou qualquer caso de uso em que a resposta instantânea seja crucial
Pré-requisitos
- Certifique-se de criar sua Tarefa de API. Para mais detalhes sobre criar uma Tarefa de API, consulte Crie uma Tarefa de API (Tarefa de API no formulário).
- Você deve ter feito o checkin da sua Tarefa de API. Para mais informações sobre fazer checkin da sua Tarefa de API, consulte Fazer checkin de tarefas de API no repositório.
Os trechos de código de amostra a seguir fornecem um procedimento para implantar uma Tarefa de API em tempo real para um dispositivo em nuvem. Você também pode passar variáveis para Tarefas de API quando eles forem implantados.
- Passo 1: Endpoint de Tarefa de API em tempo real
- Autentique o acesso à sua instância da Control Room.
- Passo 2: Endpoint de Tarefa de API em tempo real
- Um administrador pode criar uma alocação da Tarefa de API.
- Passo 3: Endpoint de Tarefa de API em tempo real
- Um administrador pode listar todas as alocações da Tarefa de API.
- Passo 4: Endpoint de Tarefa de API em tempo real
- Gere a URL e o token para implantar sua Tarefa de API.
- Passo 5: Endpoint de Tarefa de API em tempo real
- Execute sua Tarefa de API com a URL exclusiva gerada junto com o token.
Autenticação
Autentique-se para obter acesso ao seu ambiente. Isso geralmente envolve tokens de acesso ou chaves de API.
POST https://{{ControlRoomURL}}v1/authenticationHeader: X-Authorization: <<authentication token>> or Authorization: Bearer <<b
earer token>>Há dois fluxos de autenticação distintos para interagir com o endpoint em tempo real da tarefa de API:
1. Autenticação de desenvolvedor de bot (Execução de Tarefa de API):
Este fluxo permite que os desenvolvedores de bot gerem um URL e um token (Endpoint de Tarefa de API em tempo real) para executar uma Tarefa de API (Endpoint de Tarefa de API em tempo real).
Todas as chamadas API devem conter um token de API de autenticação (gera um token da Web JSON) ou um token portador dos serviços OAuth. Não é possível utilizar os dois juntos em uma API.
2. Autenticação de administrador (Alocação de Tarefa de API):
Esta autenticação é necessária para que os administradores aloquem (Endpoint de Tarefa de API em tempo real) a Tarefa de API na nuvem, para que um desenvolvedor de bot possa executar a Tarefa de API.
Criar uma alocação de Tarefa de API (administrador)
Depois de uma Tarefa de API ter o checkin feito, você poderá adicionar a Tarefa de API na nuvem. Este endpoint da API adiciona a Tarefa de API na nuvem e cria uma alocação de recursos para a sua Tarefa de API ser executada. A seção correspondente que detalha a alocação da Tarefa de API dentro da Control Room é Adicione a Tarefa de API à nuvem. A alocação de Tarefa de API é feita após uma Tarefa de API ser criada. Para mais informações sobre criar uma Tarefa de API, consulte Crie uma Tarefa de API (Tarefa de API no formulário).
PUT https://{{ControlRoomURL}}orchestrator/v1/hotbot/config/create{
"fileId": "5",
"runAsUserOrNone": 3,
"concurrencyLimit": 2
}{
"fileId": "5",
"runAsUserOrNone": 3,
"concurrencyLimit": 2
}| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| fileId | Inteiro | Sim |
O ID da automação a ser implantada. |
| runAsUserOrNone | Inteiro | Não | O apitaskrunner para estabelecer o contexto RunAsUser para Tarefas de API. Para mais informações sobre o apitaskrunner, consulte Usuário executar como para tarefa de API (apitaskrunner). Nota: Este RunAsUser não requer uma licença do Bot Runner. |
| concurrencyLimit | Inteiro | Não | Número máximo de simultaneidade a ser executada para uma determinada solicitação em tempo real (hotbot). |
(Opcional) Listar alocação de Tarefa de API (administrador)
Este endpoint da API lista todas as alocações de Tarefas de API dentro da sua Control Room. Você pode confirmar se uma determinada Tarefa de API é adicionada à lista de alocação da Tarefa de API antes de prosseguir com a geração da URL de execução da tarefa de API com token.
POST https://orchestrator/v1/hotbot/config{
"page": {
"offset": 0,
"length": 100
}
}| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| página | objeto | Não | object (PageRequest)Regras de paginação, permite filtrar com base na página desejada |
| offset | Inteiro | Não | Índice inicial da página. |
| length | Inteiro | Não | Comprimento da página. |
{
"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âmetro | Tipo | Descrição |
|---|---|---|
| fileId | Inteiro |
ID das automações. |
| filePath | String | O caminho do arquivo das automações |
| fileName | String | O nome do arquivo das automações. |
| runAsUserOrNone | Inteiro | O apitaskrunner para estabelecer o contexto RunAsUser para Tarefas de API. Para mais informações sobre o apitaskrunner, consulte Adicione a Tarefa de API à nuvem. |
| concurrencyLimit | Inteiro | Número máximo de simultaneidade a ser executada para uma determinada solicitação em tempo real (hotbot). |
Gerar URL/token de execução de tarefa
Este endpoint da API gera URL e token de execução de tarefas com os quais você poderá implantar uma Tarefa de API.
POST https://orchestrator/v1/hotbot/config/accessdetails{
"botRepositoryPath": [
"Automation Anywhere\\Bots\\My-API-Task"
]
}| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| botRepositoryPath | String | Sim | Caminho do repositório da Tarefa de API |
{
"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âmetro | Tipo | Descrição |
|---|---|---|
| url | String |
URL – Este é o endpoint do contêiner para sua próxima solicitação para implantar sua Tarefa de API. |
| X-Authorization | String | Contém o token de que você precisa fornecer nos cabeçalhos como X-Authorization. |
Depois de gerar a URL de execução de Tarefa de API, bem como os cabeçalhos necessários para executar a Tarefa de API, você pode enviar solicitações de implantação por meio da URL gerada. Se você especificar entradas, para garantir que a automação receba esses valores mapeados com sucesso, a variável para essa automação precisará ser marcada como entrada. Além disso, o nome da variável na automação precisa corresponder ao valor que está sendo mapeado no corpo da solicitação.
Executar Tarefa de API
Execute sua Tarefa de API com a URL exclusiva gerada junto com o token.
POST https://hotbot-2689-knative-0a665343-88e9-17be-8189-936dad5d0144.prod-ause1-ee.my.automationanywhere.digital/executeHeader: X-Authorization: eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIzODAiLCJ0ZW5hbnRVdWlkIjoiMGE2NjUzNDMtODhlOS0xN2JlLTgxODktOTM2ZGFkNWQwMTQ0IiwiY2xpZW50VHlwZSI6IldFQiIsIm11bHRpcGxlTG9naW4iOnRydWUsImJvdElkIjoyNjg5LCJpYXQiOjE3MDgzNTIxOTgsImV4cCI6MTcwODM5NTM5OCwiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjI5OTg3MDkyNzIxNjc5MH0.p8xsnlec7-ZbPJBfDDk1Wq0k8RqAzzsL6bK7BOtLp_jY1NgQvdAO5Yra647-94JV2cY8Vbe5H7zObia3S9oQ9dFXrnmSSSYs3_x7e_-vkaNcwx1Ev3J7lymqnH8Xc73s-TTGyebRlXiI714Ii62DJ_vKBEUvNM47V0H1FQk6xIfpzJAMMDRFZWO3MUvowgD4L-O6xre0RLapCYOSVtH_0CbM0VBfNkuwDAnF1kQeCtpWIvv_nETy7A-UdSox9GqtDp9h2Elkl-v3KJ8kEru7qT4fWZlsuzFPL7XzqkALCP39N7fxOpzlCfHYGPooLRHcFLGIPxpqi1bkfsn-Xk2BfQ{
"botInput":{
"iStrZipCode":{
"type":"STRING",
"string":"76131"
}
}
}| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| Objeto botInput | |||
| tipo | Qualquer um | Não | Por padrão, o valor é STRING. Os valores possíveis para o tipo incluem: 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. |
{
"hotBotResult":{
"botOutput":{
"State":{
"type":"STRING",
"string":"California"
},
"Place":{
"type":"STRING",
"string":"San Jose"
}
}
}
}| Parâmetro | Tipo | Descrição |
|---|---|---|
| hotBotResult | Objeto |
Objeto contendo a saída da Tarefa de API. |