Comando HB_API_GET

Envia uma solicitação GET à API do HighBond.

Sintaxe

HB_API_GET URL_solicitação_API_HighBond HEADERS informações_cabeçalho PASSWORD número TO arquivo_resposta

Parâmetros

"https://apis-us.highbond.com/v1/orgs/11594/robots"

'{"content-type": "application/vnd.api+json"}'

TO "resposta.json"

TO  "C:\Respostas de API do HighBond\resposta.json"

Exemplos

HB_API_GET "https://apis-us.highbond.com/v1/orgs/11594/robots" HEADERS '{"content-type": "application/vnd.api+json"}' TO "all_robots.json"

HB_API_GET "https://apis-us.highbond.com/v1/orgs/11594/robots" HEADERS '{"content-type": "application/vnd.api+json"}' TO "C:\HighBond API responses\all_robots.json"

{
  "data": [
    {
      "id": "17504",
      "type": "robots",
      "attributes": {
        "active_app_version": 4,
        "app_versions_count": 5,
        "name": "Concur T&E Data Integration",
        "category": "acl",
        "drive_system_user": "exYRZqYABvrjHCjV7E7j"
      }
    },
    {
      "id": "24202",
      "type": "robots",
      "attributes": {
        "active_app_version": 2,
        "app_versions_count": 2,
        "name": "Test_Steele_Adverse_Media",
        "category": "highbond",
        "drive_system_user": "exYRZqYABvrjHCjV7E7j"
      }
    }
  ]
}

COMMENT
//ANALYTIC Amostra de Solicitação de API do HighBond			
//PASSWORD 1 Token da API do HighBond:				
//RESULT FILE all_robots.json				
END		
				
HB_API_GET "https://apis-us.highbond.com/v1/orgs/11594/robots" HEADERS '{"content-type": "application/vnd.api+json"}' PASSWORD 1 TO "all_robots.json"

HB_API_GET "robots" TO "all_robots.json"

Observações

Criação de uma definição de senha e especificação do valor da senha

Quando você executa um script no Robôs que envia uma solicitação para a API do HighBond, é preciso incluir uma definição de senha com o comando que envia a solicitação. A mesma exigência se aplica a scripts executados no Analytics se você usou a ativação off-line.

Independentemente do método usado para criar a definição de senha, o valor de senha obrigatório é um token de acesso da Diligent One, que você pode gerar no Launchpad. Para obter mais informações, consulte Adquira um token de acesso da Diligent One.

Métodos para definição de senha

Adquira um token de acesso da Diligent One

Use um token existente, a menos que você tenha um motivo para criar um novo. Se o token existente não funcionar, crie um novo. O uso de um token existente reduz o número de tokens que você precisa gerenciar.

1. Execute uma das seguintes ações:

   • No menu principal do Analytics, selecione Ferramentas > Token de Acesso da Diligent One.

   • No Editor de Script, clique com o botão direito e selecione Inserir > Token da Diligent One.

   A página Gerenciar tokens da API abre no navegador. Pode ser necessário primeiro fazer o login no Diligent One.

   O acesso à página Gerenciar Tokens da API por meio do Analytics é um recurso de conveniência. Você também pode fazer login no Diligent One e acessar a página por meio do seu perfil de usuário sem usar o Analytics.

2. Execute uma das seguintes ações:

   • Usar um token existente

     1. Na coluna Token, clique no token parcialmente mascarado que deseja usar.

     2. Digite a senha da conta do Diligent One e clique em Confirmar.

        O token não mascarado é exibido.

     3. Clique em Copiar para copiar o token.

        Dica

        Não feche a caixa de diálogo que contém o token até colar corretamente o token.

   • Criar um novo token

     1. Clique em Adicionar token > Analytics.

     2. No painel lateral Novo token do Analytics, especifique estas informações:

        Campo ou opção	Descrição
        Descrição	Insira uma descrição que forneça informações úteis, como: O propósito do token Onde o token é usado – por exemplo, o nome e a localização do script do Analytics, ou o nome e a localização da tarefa do robô
        Expiração do token	Habilitada o token expira após um número de dias especificado Desabilitada o token nunca expira Nota Sua organização pode ter uma política de segurança que exige a expiração de tokens após um determinado período. É recomendado criar tokens com expiração. O Diligent One enviará uma notificação automática por e-mail antes da data de expiração.
        Expiração em	Especifique o número de dias até a expiração do token (1 a 365).
        Senha	Digite a senha da conta do Diligent One.

     3. Clique em Gerar token.

     4. Clique em Copiar para copiar o token.

        Dica

        Não feche o painel lateral que contém o token até colar corretamente o token.

3. Dependendo do método de definição de senha que você está usando, faça uma das seguintes opções:

   • Tag de análise PASSWORD No Designer de Tarefa em um robô ACL, cole o token copiado em um campo de parâmetro de senha.

   • Comando PASSWORD No Analytics, cole o token copiado em um prompt de senha exibido durante a execução de scripts.

   • Comando SET PASSWORD No Analytics, cole o token no ponto apropriado na sintaxe do comando SET PASSWORD em um script.

4. No Launchpad, feche a caixa de diálogo ou o painel lateral que contém o token.

   Se tiver criado um novo token, uma versão parcialmente mascarada do token é adicionada ao início da lista de tokens.

   Para obter mais informações, consulte Criando e gerenciando tokens de acesso da Diligent One.