Skip to main content

Getting started

These pages contain information on how to use the Catalog API.

The Catalog API makes it possible to load data into the Partium system and to update it later.

The API can be used to insert, update or delete part types, images, organizations and to manage BOM (Bill of Materials) hierarchies. The assignments of part types to the BOM hierarchy (assemblies) and the assignment of assemblies to organizations can also be managed.

Go to Part data types used by Partium to learn about the different data types and their relations in Partium.

APIKEY​

In order to be able to use the Catalog API an API key must be generated.

Go to section API Keys and create an API key for the Catalog API.

Authentication​

After the API key has been created, the authentication system can be used for getting access.

First steps​

Organizations​

The initial step is to create a main (root) organization in the catalog. Depending on the needs, additional sub-organizations can be created.

Go to Organizations in Partium for further information about the use of organizations in the Partium system.

Go to section Managing organizations to learn about the API for organizations.

Set up an ontology​

The next step is to set up an ontology describing your data. Basically, it describes the possible attributes of part types and their structure.

Go to section Define your data ontology to learn about the API for managing the ontology.

Start adding part types​

After an ontology has been defined, part types can be added to the catalog.

Go to section Managing part types to learn about the API for part types.

Set up a BOM hierarchy​

An optional hierarchical structure called "Bill of Materials" (BOM) can be defined to organize the data. The nodes in this tree structure are called assemblies and part types can be assigned to these assemblies.

Go to section Managing Bill of Materials to learn about the API for assemblies.

Manage the catalog​

After new data is added or modified in the catalog, the system immediately starts processing them. To make the processed data available for searching an import must be triggered.

The Catalog API provides endpoints for checking the status of the catalog and for triggering imports.

See section Managing the catalog.

Error handling​

In general, the catalog API allows bulk operations. The system provides information about the actions taken and the failed operations in the response. Also, depending on the overall state of the catalog, update operations may not be allowed.

See section Error handling to learn about the standard responses and error handling.