ONe allows you to create commercial plugins that allow you to extend the functionality and integrate with other applications.

⚠️

See here to learn more about plugins in ONe.

Table of contents Glossary GET all plugins data for specified plugin id POST - Create/Update plugin data for plugin and specified product GET plugin data for specified plugin and product DELETE plugin data for specified plugin and product

Glossary

Name	Explanation
`pluginId`	Identifier of plugin
`productId`	Identifier of product
`metadata`	information used to describe information resources or information objects, providing detailed data on the attributes of resources or information objects, in order to facilitate their finding, identification and management of these resources

GET all plugins data for specified plugin id

In order to get all plugins data use GET/api/v1/catalog/integrations/auth-required/pluginsData/{pluginId} using specific ID. The diagram below shows the dependence of communicating with the API:

Use the parameter in query below to get information about specified plugin:

pageNumber

pageSize

and the parametr in path:

pluginId Example request:

json
curl -X GET 
"https://api-preprod.one.unity.pl/api/v1/invoices/integrations/auth-required/pluginsData/demoPlugin?pageNumber=1&pageSize=10" 
-H  "accept: */*" 
-H  "one-tenant: {tenant}" 
-H  "ApiAuth: {apiKey}"

In response you will receive information about plugin

Example response:

json
{
  "items": [
    {
      "pluginId": "demoPlugin",
      "productId": "2062544635463",
      "metadata": {
        "test": 456
      }
    },
    {
      "pluginId": "demoPlugin",
      "productId": "AVAC_30202_3798",
      "metadata": {
        "test": 456
      }
    },
    {
      "pluginId": "demoPlugin",
      "productId": "HELU_23300",
      "metadata": {
        "test": 456
      }
    }
  ],
  "totalItems": 3,
  "pageNumber": 1,
  "totalPages": 1,
  "pageSize": 10,
  "nextPage": null
}

POST - Create/Update plugin data for plugin and specified product

In order to create or update plugin data for plugin and specified product use POST /api/v1/catalog/integrations/auth-required/pluginsData/{pluginId}/by-product. The diagram below shows the dependency of communicating with the API:

Use the parameter in query below to update selected products:

productId

Example request:

json
curl -X POST
"https://api-preprod.one.unity.pl/api/v1/catalog/integrations/auth-required/pluginsData/demoPlugin" 
-H  "accept: */*" 
-H  "one-tenant: {tenant}" 
-H  "ApiAuth: {apiKey}"
-d " {
  "productId": "product4111",
  "metadata": {
  "test": 456
}
}"

GET plugin data for specified plugin and product

In order to get information about plugin data for specified plugin and product use GET/api/v1/catalog/integrations/auth-required/pluginsData/{pluginId}/by-product . The diagram below shows the dependence of communicating with the API:

Use the parameter in query below to get information about plugin:

productId and the parametr in path:

pluginId

Example request:

json
curl -X GET
"https://api-preprod.one.unity.pl/api/v1/catalog/integrations/auth-required/pluginsData/demoPlugin/by-product?productId=product4111"
-H  "accept: */*"
-H  "one-tenant: {tenant}"
-H  "ApiAuth: {apiKey}"

In response you will receive information about plugin

Example response:

json
{
  "pluginId": "demoPlugin",
  "productId": "product4111",
  "metadata": {
    "test": 456
  }
}

DELETE plugin data for specified plugin and product

In order to import single product packagings use DELETE /api/v1/catalog/integrations/auth-required/pluginsData/{pluginId}. The diagram below shows the dependency of communicating with the API:

Use the parameter in query below to get information about plugin:

productId and the parametr in path:

pluginId

Example request:

json
curl -X DELETE 
"https://api-preprod.one.unity.pl/api/v1/catalog/integrations/auth-required/pluginsData/demoPlugin/by-product?productId=product4111" 
-H  "accept: */*" 
-H  "one-tenant: {tenant}" 
-H  "ApiAuth: {apiKey}"

Plugin data

Table of contents

Glossary

GET all plugins data for specified plugin id

POST - Create/Update plugin data for plugin and specified product

GET plugin data for specified plugin and product

DELETE plugin data for specified plugin and product