Product Entitlement Customer Experience API
home
Overview
The Product Entitlement Customer Experience API enables you to have more control over how you access your entitlements. The API provides access to the same downloads as the Product Download Hub however it grants you additional functionality to access your entitled downloads programmatically. Using the API, you can integrate viewing, searching, and downloading products based on your entitlements into your own systems and workflows.
We define entitlements, releases, and artifacts (or downloadable files) as follows:
Entitlements
The products you are licensed to use.
Releases
The downloadable versioned products that form your entitlements.
Artifacts (or downloadable files)
The product contents from the releases you are entitled to.
Entitlement rights
Entitlements are further broken into the following subcategories which describe the type of rights the entitlement grants.
Access
Your right to products through the Arm Flexible Access (AFA) or Arm Total Access (ATA) subscription programs.
Download
Your right to download the product.
Support
Your right to online or in-person support calls for the product.
Software license
Your right to activate the software with the software license.
Manufacture
Your right to tape out the product.
These entitlement rights correspond to values assigned to the rightTo
field. The rightTo
field is further documented within the SPECIFICATION section.
Intended Audience
The Product Entitlement Customer Experience API documentation is intended for software developers who:
- work for Arm partners that are entitled to products Arm provides
- understand how RESTful APIs work
Versioning
Our API follows the Semantic Versioning Specification for version numbering. For more information on this specification, see Semantic Versioning 2.0.0.
The version shows up in the different endpoints in the format /vX/. For example, https://api.arm.com/e-product-entitlement-customer/v1/entitlements.
The current version is v1.