APIs da Control Room

A Automation Anywhere Control Room oferece APIs que permitem personalizar a forma como você (e suas automações) interagem com a Automation Anywhere.

Importante:
  • No Automation 360 v.34, os seguintes endpoints da API WLM estão obsoletos e serão descontinuados (EoL) junto com a versão v.38:
    • POST /v3/wlm/workitemmodel
    • GET /v3/wlm/workitemmodels/{id}
    • GET /v3/wlm/queues/{id}
    • POST /v3/wlm/queues/{id}/consumers
    • POST /v3/wlm/queues/{id}/participants
    • PUT /v3/wlm/queues/{id}/members/{userId}
    • POST /v3/wlm/queues/{id}/file
    • PUT /v3/wlm/queues/{id}/workitems/{workItemId}
    Substitua os endpoints de API acima pelos seguintes:
    • POST /v4/wlm/workitemmodel
    • GET /v4/wlm/workitemmodels/{id}
    • GET /v4/wlm/queues/{id}
    • POST /v4/wlm/queues/{id}/consumers
    • POST /v4/wlm/queues/{id}/participants
    • PUT /v4/wlm/queues/{id}/members/{userId}
    • POST /v4/wlm/queues/{id}/file
    • PUT /v4/wlm/queues/{id}/workitems/{workItemId}
  • A partir do Automation 360 v.34, os endpoints da API do Bot Scheduler: /v1/schedule/automations estão obsoletos e foram substituídos por /v2/schedule/automations. A versão v1 será descontinuada (EoL) junto com a versão v.38

Você pode visualizar e navegar por todos os módulos da API da Control Room e pelos endpoints associados nas seguintes seções de referência de API.

As diferentes versões da API abaixo representam diferentes iterações de APIs ao longo do tempo. À medida que uma API evolui, novos recursos ou melhorias são introduzidos. Para gerenciar essas mudanças e manter a compatibilidade com os aplicativos existentes, os desenvolvedores usam o controle de versão.

Endpoints v1

Módulos Descrição
API de autenticação Use as APIs de autenticação v1 para verificar a autenticidade e a integridade dos JSON Web Tokens (JWTs), bem como para encerrar sessões de usuários habilitas.
API de auditoria Use as APIs de auditoria para recuperar dados do log de auditoria da sua Control Room.
API de dispositivo Use as APIs de dispositivo para identificar todos os usuários disponíveis com licenças não assistidas de Bot Runner ou filtre usuários por nome.
API de automações Obsoleto Use as APIs do Bot Scheduler v1 (APIs de automação) para criar, atualizar, excluir e retornar detalhes sobre as automações agendadas.
API de gatilhos Use as APIs de gatilho para mapear gatilhos para usuários ou funções de um usuário do executor de bots assistidos. Você também pode criar e excluir gatilhos de eventos.
API de execução de tarefas da API Use as APIs de execução de tarefa de API para gerar um URL e um token que iniciam uma execução de tarefa de API por meio de um endpoint de API.
API de gerenciamento de políticas Use as APIs de gerenciamento de políticas para gerenciar a análise de código, políticas e regras dentro da Control Room.
API do AI Agent Studio Use as APIs do AI Agent Studio para definir e conectar-se a modelos de Conexões de modelo personalizadas. Você também pode recuperar e excluir Conexões de modelo personalizadas.

Endpoints v2

Módulos Descrição
API de autenticação Use as APIs de autenticação v2 para gerar, atualizar e gerenciar os JSON Web Tokens (JWT) obrigatórios para autorização em todas as APIs da Enterprise Control Room.
APIs de gerenciamento de usuários Use as APIs de gerenciamento de usuários para visualizar e excluir funções e usuários na sua Control Room.
API do Credential Vault Use as APIs do cofre de credenciais para criar, recuperar, atualizar e excluir credenciais, valores de atributos de credenciais, cofres e chaves.
API de execuções do bot Orchestrator Use a API v2 Bot Execution Orchestrator para monitorar dispositivos.
API de gerenciamento de repositório Use as APIs de gerenciamento de repositório para executar tarefas específicas em objetos (bots, pastas e arquivos) aos quais você tem permissão de acesso na Control Room.
API BotInsight Use as APIs de Bot Insight acessa insights comerciais em tempo real e dados digitais de desempenho da força de trabalho para usar dados de produtividade de nível de conteúdo das automações que são implantadas.
API BLM Use as APIs de Gerenciamento do Ciclo de Vida do Bot (BLM) para exportar e importar bots com arquivos dependentes e pacotes de comando para gerenciamento abrangente do ciclo de vida de automação.
API do pool de dispositivos Use as APIs do pool de dispositivos para criar, listar, atualizar e excluir grupos de dispositivos.
API de licença Use as APIs de licença para recuperar detalhes da licença da Control Room e sincronizar manualmente a Control Room com o servidor de licença após a realocação ou renovação da licença.
APIs de compositor de processos Use as APIs do Processor Composer para criar uma nova solicitação de processos, recuperar o formulário inicial e solicitar por ID de referência.
API de automações Use as APIs do Bot Scheduler v2 (APIs de automação) para criar, atualizar, excluir e retornar detalhes sobre as automações agendadas.
API de gerenciamento de políticas Use as APIs de gerenciamento de políticas v2 para gerenciar análise de código, políticas e regras dentro da Control Room.

Endpoints v3

Módulos Descrição
API de implantação de bot Use a API Bot Deploy v3 para implantar bots do espaço de trabalho público em dispositivos Bot Runner.
API de gerenciamento da carga de trabalho Use as APIs do Workload Management (WLM) v3 para gerenciar de maneira programática e criar modelos de itens de trabalho, filas, itens de trabalho e automações na sua Control Room.
API de migração (migração de bot) Use as APIs de migração v3 para migrar TaskBots e MetaBots que foram criados nas versões do cliente Enterprise 11 e Enterprise 10 para o Automation 360.
API de execuções do bot Orchestrator Use as APIs do Bot Execution Orchestrator v3 para monitorar o progresso da atividade de automação.

Endpoints v4

Módulos Descrição
API de implantação do bot (V4) Use a API do Bot Deploy v4 para implementar bots do espaço de trabalho público em dispositivos executores de bots.
API de gerenciamento da carga de trabalho Use as APIs do Workload Management (WLM) v4 para gerenciar de maneira programática e criar modelos de itens de trabalho, filas, itens de trabalho e automações na sua Control Room.
API de migração (migração de bot) Use as APIs de migração v4 para migrar TaskBots e MetaBots que foram criados nas versões Enterprise 11 e Enterprise 10 do cliente Enterprise para o Automation 360.
Nota: Para evitar erros e garantir o processamento tranquilo das solicitações, lembre-se de que todos os nomes de parâmetros JSON diferenciam maiúsculas de minúsculas. Para obter mais informações, consulte as seções relevantes da documentação de referência da API para obter diretrizes e exemplos claros para ajudar a criar as consultas e solicitar textos com o uso correto de maiúsculas e minúsculas.

Como começar com APIs da Control Room

Todos os pedidos devem incluir um cabeçalho X-Authorization com o símbolo de autenticação JSON ou cabeçalho Authorization com um token do portador para pedidos para a Control Room. As seções a seguir fornecem detalhes sobre as APIs da Control Room disponíveis, métodos, recursos, protocolos de autenticação, parâmetros e cabeçalhos, assim como exemplos de pedidos e respostas comuns.

Nota: O símbolo do portador é suportado na verão Automation 360 v.27 e mais recente. Ele não é compatível e é ignorado nas versões anteriores. Obtenha o token do portador dos nossos serviços OAuth. Use X-Authorization (usando a API de autenticação) ou Authorization (usando o OAuth) para autorizar o seu acesso. Não é possível utilizar os dois na mesma API.
Você pode usar a documentação do swagger da Control Room para visualizar e executar as APIs. Acesse a documentação do swagger da Control Room usando o link https://{control-room}/swagger/ e substitua {control-room} pela instância da Control Room. As seguintes seções fornecem informações úteis sobre como escrever uma solicitação de API da Control Room:

Política de descontinuação de API

A descontinuação da API indica que uma API não é mais recomendada para uso, mas é funcional. Os desenvolvedores são incentivados a migrar para versões mais atualizadas e compatíveis da API. A API estará disponível até a data do fim da vida útil (EoL) e a versão de lançamento para permitir uma transição tranquila.

API EoL (Fim da Vida Útil) indica a data e a versão de lançamento em que a API deixará de funcionar e não estará mais disponível para uso. Os desenvolvedores devem concluir a migração para as versões mais atualizadas e compatíveis da API antes dessa data.

Os seguintes cenários podem exigir a descontinuação de APIs:

  • Vulnerabilidades de segurança: versões mais antigas da API contêm vulnerabilidades de segurança conhecidas que foram corrigidas em versões mais recentes.
  • Dívida técnica: as versões mais antigas da API podem ser criadas com base em tecnologias, abordagens ou estruturas desatualizadas que não são mais suportadas, dificultando a manutenção ou os aprimoramentos.
  • Desempenho: versões mais antigas da API não são otimizadas para casos de uso modernos ou aumentos de escala, levando a um desempenho ruim e tempos de resposta mais lentos.
  • Experiência do usuário: versões de API obsoletas contêm endpoints confusos ou redundantes que podem dificultar a navegação para os usuários.

APIs serão suportadas por um período mínimo de 2 anos. Após 2 anos, um anúncio de descontinuação de uma API pode ser feito, com a API estando disponível por pelo menos mais um ano (quatro versões) para oferecer tempo suficiente para migrar para a versão mais recente.

Nota: A política acima não se aplicará à descontinuação devido a vulnerabilidades de segurança em APIs públicas. Em tais casos, é necessária ação imediata para mitigar riscos e faremos todo o possível para comunicar essa mudança a você o mais rápido possível.