Skip to main content

Overview

Welcome to the Partium SDK documentation!

First steps​

The Partium SDK provides you a fast and easy way to integrate Partium into your JavaScript based application. Jump to the Getting Started section, to learn how to setup the Partium SDK for your application.

Advanced searches​

Once you have setup the Partium SDK and performed your first search, have a look at Search modalities, to learn how to perform more about how to use different search modalities and perform more complex searches.

Authentication​

For authenticating your application in the Partium system, you can either use username and password or authenticate via an API-key. Go to API Keys to manage your API-keys.

Advanced usage​

Have a look at the Advanced usage section, if you want to use more features of the Partium SDK, like Event-Logging or loading available filters. In that section you will also find more details about how to customize your SDK configuration.

Upgrading​

The Upgrading section informs about how to upgrade from one Partium-SDK version to another and lists all deprecations and breaking changes.