External Service HP Warranty API
Last updated
Last updated
© Patch My PC 2024
Applies to: Advanced Insights
Advanced Insights (this is not relevant for Patch Insights) can access device warranty information from a variety of vendors. For access to HP warranty information you will need to sign up to HP Workforce Experience, enrol all the HP devices you want to collect warranty data on and set up a developer account to access the warranty data.
You will need to be a HP Workforce Experience customer for this to work, please speak to your HP representative about becoming a customer.
First, we will create the developer account needed to interact with the HP Workforce Experience api.
The url for the HP developer portal is https://developers.hp.com/
First, you will need to create an account if you do not have one already. If you have a HPID for HP Workforce Experience, you can use this account.
Once you have registered, you will need to message your HP representative and request access to the HP Proactive Insights APIs tech group for your developer account.
The link to generate api credentials is: https://developers.hp.com/group/1275/manage-credentials/apis
Please visit the link above to open the credentials generation page. You will be show the following options below. Click Get Credentials in the HP Proactive Insights Analytics section.
If the page has an error screen like shown below, HP have not enrolled your developer account in the HP Proactive Insights APIs tech group. Please contact HP again to have your account enrolled in the HP Proactive Insights API tech group.
You will need to provide the following information:
Credentials name: We recommend "Advanced Insight Warranty"
Description: We recommend "API Keys for Advanced Insight Warranty"
Developer Redirect Url: This will be used by HP to redirect when you log in. This needs to be your Advanced Insights in the following format https://FQDN:PORT/app/main/view/warranty. Example https://contoso.local:444/app/main/view/warranty
Client ID: Leave blank
Tick Read Checkbox
Click create and you will be redirected back to the previous page.
Once you have been redirected, there will be a green success banner on top of the page. Please now click the "My API Credentials" link in the banner.
Now click on the newly created app by click the app name, this will load the app details page.
Here you will see information about the newly created app.
We need to copy
The API ClientId
The API Secret (click "Show Secret" to get this entry)
It's a good idea to double check that the Redirect URL is correct. You can come back to this page if you receive a redirect URL error when trying to authenticate. You will also want to change the URL if your installation FQDN of Advanced Insights changes in the future.
We now need to copy API ClientId and API Secret to Advanced Insights.
Go to Administration -> Settings -> External Services
Based on the location of the HP Workforce Experience portal you used, select US or EU.
Copy and paste the API Client ID into the Client ID input
Copy and paste the API Client Secret into the Client Secret input
Save settings.
The app client secret has an expiration date of one year from the date of creation. Please make a note of when this key will need to be rotated.
If you are already a HP Workforce Experience customer, you may not need to do the registration steps below but you will need access to the HP Workforce Experience Portal.
HP has two versions of HP Workforce Experience, one for US (and ASIA) customers and one for EU customers.
You will need to sign up to the appropriate version based on your companies location.
Mistakes here will cause issues in the future. Here are the access urls.
US portal: https://admin.hp.com/
EU portal: https://eu.admin.hp.com/
When you have registered and logged in, you will be greeted by the home experience of HP Workforce Experience. On the left hand side, you will need to click "Assets" to begin importing your HP devices into HP Workforce Experience.
HP Workforce Experience allows you to import your device using four different mechanisms. Currently only Intune Import and Asset enrolment allow for warranty data collection, manual and csv upload do not trigger warranty collection by design. To begin importing devices, please click the "Add" button in the top left of the page.
To begin importing from Intune, please click the Intune Import button then click next.
You will be now asked to provide your Intune Domain Name, this can be found by going to the Intune portal, clicking Tenant Administration on the left hand menu and copying the Tenant name from the Tenant Status page.
You will now be greeted by the Microsoft Login flow, please log in using your microsoft credenitals as normal. You will be then presented the list of permission HP requests to perform the Intune import.
All of the permissions requested by HP is for the HP Workforce Experience platform. They are not defined/requested by Patch My PC. Advanced Insights does not use or read any of your Intune data.
Once you have accepted the permission, the connection to Intune will be completed by HP.
You will now be asked if you wish to import Assets from Intune Groups, or to import all of your assets.
We recommend you use the Group functionality, as this allows you to only provide HP the devices you wish to collect warranty information on. Only use full import if you really want every device in HP Workforce Experience as it is vendor agnostic and will collect all competing vendor devices.
We shall continue using Group import only.
When you click on Import assets only from Intune groups, you will be presented with a full list of all your groups in Intune. You can filter out the groups you want to import and you can import multiple groups. Select the groups you want to import and click Import.
Intune will now begin importing your selected devices. You will receive a notification on begin and completion of the import.
You can also check progress by navigating to the logs link on the left hand side.
To enrol your device by Asset Enrolment, please use the following HP documentation to distribute the agent.
Once the devices are imported, HP Workforce Experience will begin collecting warranty information. This process can take some time, depending on how many devices you have imported.
Collecting warranty in Advanced Insights works in the same way as the other providers, but you will need to log into HP on bulk caching.
Navigate to the warranty dashboard.
To begin, click the "Bulk Processing" statistic to begin re-caching warranty.
You will be asked to log in to HP, click yes and Advanced Insights will go to HP to log in.
If you receive a redirect url is incorrect error. Please go back to your developer app and check the redirect url provided.
Once you have logged in, HP will redirect you back to Advanced Insights and warranty will begin caching warranty data.
