Skip to main content

Getting started

In this section we will show you how to integrate the Partium SDK into your application.

SDK Installation​

The Partium-SDK can be added to all JavaScript based projects.

NPM configuration​

Before you can install the Partium SDK, make sure you have npm installed. Then you need to add the Partium npm registry to your npm configuration:

npm set registry https://npme.partium.io

Login to the npm registry and provide the username and password that you received from your Partium contact person. For the eMail address you can just use your company email address:

npm login

Package installation​

Now you can install the Partium-SDK package:

npm install js-partium-sdk

You have successfully installed the Partium-SDK. Before you can trigger your first search, you need to initialize the SDK with an API-key.

SDK initialization​

To use the Partium-SDK, you need to first initialize it:

import { Partium } from 'js-partium-sdk';

...

Partium.initApiKey('<API-KEY>');

API-KEYs can be generated and managed in the API Keys section.

:::

Everything is ready for your first search. Let's start with a simple text-search:

Partium.search.performSearch(
  {
    organizationName: '<organization-name>',  // e.g.: 'Partium' (get this from your Partium contact person)
    searchLanguage: '<search-language-code>',  // e.g.: 'en'
    text: 'valve',
  }
).subscribe((result: SearchOutput) => {
  // search successful, find results in result.searchResults
}, (error: SdkError) => {
  // an error happened during the search
});

The search also allows to add multiple search-inputs at once. These searches are called multi-modal searches. In the following example, we combine text-search with attribute filter search:

Partium.search.performSearch(
  {
    organizationName: '<organization-name>',  // e.g.: 'Partium'
    searchLanguage: '<search-language-code>',  // e.g.: 'en'
    text: 'valve',
    attributeFilters: {
      ['Color']: ['Red', 'Blue', ...],  // replace with filter that is supported in your data
    },
  }
).subscribe((result: SearchOutput) => {
  // search successful, find results in result.searchResults
}, (error: SdkError) => {
  // an error happened during the search
});