Comando HB_API_GET

Envía una solicitud GET a la API de HighBond.

Sintaxis

HB_API_GET URL_solicitud_API_HighBond HEADERS información_encabezado PASSWORD núm TO archivo_respuestaHighBond_API_request_URL

Parámetros

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

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

TO "response.json"

TO "C:\HighBond API responses\response.json"

Ejemplos

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 Muestra de Solicitud de la API de HighBond			
//PASSWORD 1 Token de API de 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"

Observaciones

Creación de una definición de contraseña y especificación de un valor de contraseña

Cuando ejecuta un script en Robots que envía una solicitud a la API de HighBond, debe incluir una definición de contraseña con el comando que envía la solicitud. El mismo requisito se aplica a la ejecución de scripts en Analytics cuando usa la activación sin conexión.

Independientemente del método que utilice para crear una definición de contraseña, el valor de la contraseña requerida es un token de acceso a Diligent One que puede generar en Launchpad. Si desea obtener más información, consulte Adquiera un token de acceso de Diligent One.

Métodos de definición de contraseñas

Adquiera un token de acceso de Diligent One

Utilice un token de acceso existente, a menos que tenga un motivo para crear uno nuevo. Si el token existente no funciona, cree uno nuevo. El uso de un token existente reduce la cantidad de tokens que necesita administrar.

1. Realice una de las siguientes acciones:

   • En el menú principal de Analytics, seleccione Herramientas > Token de acceso Diligent One.

   • En el Editor de scripts, haga clic con el botón derecho del ratón y seleccione Insertar > Token de Diligent One.

   Se abre la página Administrar tokens de API en el navegador. Es posible que deba iniciar sesión primero en Diligent One.

   Acceder a la página Administrar tokens de API desde Analytics es una función muy práctica. También puede iniciar sesión en Diligent One para acceder a la página desde su perfil de usuario sin usar Analytics.

2. Realice una de las siguientes acciones:

   • Usar un token existente

     1. En la columna Token, haga clic en el token parcialmente enmascarado que desea utilizar.

     2. Introduzca la contraseña de su cuenta de Diligent One y haga clic en Confirmar.Diligent One

        Se muestra el token sin enmascarar.

     3. Haga clic en Copiar para copiar el token.

        Consejo

        No cierre el cuadro de diálogo que contiene el token hasta que haya pegado el token correctamente.

   • Cree un nuevo token

     1. Haga clic en Agregar token > Analytics.

     2. En el panel lateral Nuevo token de Analytics, especifique la siguiente información:

        Campo u opción	Descripción
        Descripción	Introduzca una descripción que proporcione información útil, por ejemplo: El propósito del token Dónde se utiliza el token, por ejemplo, el nombre y la ubicación del script de Analytics, o el nombre y la ubicación de la tarea del robot
        Caducidad del token	Activado el token caduca después del número de días que especifique Desactivado el token nunca caduca Nota Es posible que su organización tenga una política de seguridad que requiera que los tokens caduquen después de cierto tiempo. La creación de tokens con fecha de caducidad es una buena práctica. Diligent One le envía por correo electrónico una notificación automatizada antes de la fecha de caducidad.
        Caduca en	Especifique los días que faltan para que el token caduque (de 1 a 365).
        Contraseña	Introduzca la contraseña de su cuenta de Diligent One.

     3. Haga clic en Generar token.

     4. Haga clic en Copiar para copiar el token.

        Consejo

        No cierre el panel lateral que contiene el token hasta que haya pegado el token correctamente.

3. En función del método de definición de contraseña que utilice, realice una de estas acciones:

   • Etiqueta de estudios analíticos PASSWORD En el Diseñador de la tarea de un robot ACL, pegue el token que ha copiado en un campo de parámetro de contraseña.ACL robot

   • Comando PASSWORD En Analytics, pegue el token que ha copiado en la solicitud de contraseña que aparezca durante la ejecución del script. Analytics

   • Comando SET PASSWORD En Analytics, pegue el token que ha copiado en el lugar adecuado de la sintaxis del comando SET PASSWORD de un script.Analytics

4. En Launchpad, cierre el cuadro de diálogo o el panel lateral que contiene el token.

   Si creó un nuevo token, se agrega una versión parcialmente enmascarada del token en la parte superior de su lista de tokens.

   Si desea más información, consulte Creación y administración de tokens de acceso de Diligent One.