Skip to main content

API key information

GET 
/pim/keyinfo
  • No permissions are required for ApiKey.
  • Example URI:

Your own API key: https://instancename.piminto.com/api/en-us/pim/keyinfo

Other verification API key: https://instancename.piminto.com/api/en-us/pim/keyinfo/?key=VerifyAPIkey

Provides the ability to retrieve information about your own API key or another API key other than your own.

Returns

  • Permissions Information: Returns details about the permissions associated with the provided API key or the key specified in the {key} query parameter. These permissions dictate the actions that can be performed.
  • Available Views: Provides a list of Views accessible to the specified key, allowing users to access specific subsets of data.
  • PIM Counters: Includes information such as the total count of views, attributes defined in the PIM, size of assets (in bytes), and the total count of SKUs.
  • PIM Limits: Presents details about the limits imposed on PIMS within the selected plan, covering aspects like the total count of views, attributes, asset size, and SKU count.

Returns an Error if the API key is invalid or expired.

The following permissions are available for API keys in PIMS:

  • Access Manager (system permission name: pim_security): Allows the management of access groups and API keys.
  • Data Manager (system permission name: pim_manager): Permits the definition of attributes, categories, and views in the PIMS.
  • Data Viewer (system permission name: pim_user): Provides read-only access to product and category data in the PIMS.
  • Data Editor (system permission name: pim_editor): Enables adding, editing, and deleting products in the PIMS.
  • Data Importer (system permission name: pim_import): Allows the importing of data into the PIMS.
  • Data Exporter (system permission name: pim_export): Allows the exporting of data from the PIMS.

The API key expiration date is a global parameter set in the PIMS settings.

Information about permissions for the verification key will only contain information about the permissions to which you have access.

Please note the following important aspect of data management in PIM:

  • When granting pim_security permissions, pim_manager permissions are automatically granted.
  • When granting pim_manager permissions, pim_editor permissions are automatically granted.
  • When granting pim_editor permissions, pim_user permissions are automatically granted.
  • Accounts with pim_security or pim_manager permissions cannot be associated with views (views define which data is available for the API key).

Request​

Query Parameters

    key string

    API key different from your own that you want to verify.

Responses​

success

Schema
    status_message stringrequired

    Provides a message about the API key's status and the expiration date of the key.

    operations objectrequired

    The "operations" object contains a set of operations that are authorized for the API key. Each operation has an "allowed" key that indicates whether the operation is permitted or not. A value of 1 for the "allowed" key signifies that the operation is allowed. The "label" key provides a human-readable description of the operation, while the "group" key specifies the category to which the operation belongs. The "group" key can be used to group operations together, making it easier for the users to understand the purpose of each operation.

    pim_security object

    Allows the management of access groups and API keys.

    allowed integer
    group string
    label string
    pim_manager object

    Permits the definition of attributes, categories, and views in the PIMS.

    allowed integer
    group string
    label string
    pim_user object

    Provides read-only access to product and category data in the PIMS.

    allowed integer
    group string
    label string
    pim_editor object

    Enables adding, editing, and deleting products in the PIMS.

    allowed integer
    group string
    label string
    pim_import object

    Allows the importing of data into the PIMS.

    allowed integer
    group string
    label string
    pim_export object

    Allows the exporting of data from the PIMS.

    allowed integer
    group string
    label string
    views object
    nameview object
    isDefault stringrequired

    Possible values: [y, n]

    comment string
    pim_counters objectrequired
    totalViews objectrequired
    value integerrequired
    description stringrequired
    totalAttributes objectrequired
    value integer
    description string
    totalStorageSize objectrequired
    value integerrequired
    description stringrequired
    totalSKUs objectrequired
    value integerrequired
    description stringrequired
    pim_limits objectrequired
    maxViews objectrequired
    value integerrequired
    description stringrequired
    maxAttributes objectrequired
    value integerrequired
    description stringrequired
    maxStorageSize objectrequired
    description stringrequired
    value integerrequired
    maxSKUs objectrequired
    description stringrequired
    value integerrequired
    status stringrequired

    The status of the API request. A value of "OK" indicates that the request was successfully sent and processed

Loading...