Connect to HP Insights APIs

HP Insights APIs let you integrate external applications and systems with HP Insights, automate administrative and printing workflows, and retrieve data for reporting and analysis. You can use APIs to export data to Power BI and other reporting tools, automate user management, submit print jobs, or connect HP Insights with other business systems.

API access is configured in different areas of the web console, depending on the API and access method. API key and OAuth 2.0 client application access are configured under Analysis > API. The separately named Integration APIs are turned on under Account Settings > Settings.

API access methods

HP Insights provides three API access methods: an API key, OAuth 2.0 client applications and the Integration APIs key. The method you use depends on the API you want to access. Each method has its own configuration location, credentials and supported APIs.

Method Set up in APIs Access or capability
API key Analysis > API > Access via API Key Device Meter Data, Device Status Data, Device Toner Data, Print Transactions Data, Monthly Print Data and SNMP Configuration Data Read only
OAuth 2.0 client application Analysis > API > Client Application Billing Accounts, SCIM v2.0, Device, Document Management, Device Scout or Print Scout, one API for each application Full Access or Read Only, set for each client application
Integration APIs key Account Settings > Settings > Enable Integration APIs User Import, User Removal and User Registration Removal User and registration management

APIs that use an API key

The API key gives read-only access to device and print data for reporting and analysis, for example in Power BI. One Authorization Key covers all the API key endpoints. See Extract analytics data with an API key.

APIs that use OAuth 2.0

For APIs that use OAuth 2.0, create a client application in Analysis > API > Client Application. Each client application has its own Client ID and Client Secret and gives access to one API. You can give the application Full Access or Read Only permissions. See Create a client application.

The following APIs are available when you create a client application:

API Description Documentation
Billing Accounts API Create and manage billing accounts programmatically, including account details, limits and access permissions. HP US Billing Accounts API documentation or HP EU Billing Accounts API documentation
SCIM v2.0 API Create, retrieve, update and remove users programmatically, including guest users. HP US SCIM v2.0 documentation or HP EU SCIM v2.0 documentation
Device API Exchange device inventory and status data with external systems, such as ServiceNow. Retrieve device information, supply levels, meter readings and status, or register, update and remove devices. HP US Device API documentation or HP EU Device API documentation
Document Management API Submit, store, manage and release print documents through external applications and systems. Supports Secure Print Direct for sending print-ready files straight to a printer. HP US Document Management API documentation or HP EU Document Management API documentation
Device Scout API Retrieve and manage Device Scouts and their configuration, including discovery tasks, scan ranges and SNMP v3 settings. HP US Device Scout API documentation or HP EU Device Scout API documentation
Print Scout API Retrieve and manage Print Scouts, including listing and filtering Print Scouts, archiving and unarchiving them, and managing common settings. HP US Print Scout API documentation or HP EU Print Scout API documentation

Integration APIs

Integration APIs is the name of the API feature used for bulk user import, user removal and registration removal with CSV files. It includes the User Import, User Removal and User Registration Removal APIs. Turning on Enable Integration APIs under Account Settings > Settings creates a separate Authorization Key for them. See Import and remove users with the API.

Next steps

Related topics