catalogi-api.md

Catalogi API

Dependencies

In order to use the Catalogi API, the Catalogi API module needs to be added as a dependency. The following can be added to your project, depending on whether Maven or Gradle is used:

Backend

The samples below assume the valtimo-dependency-versions module is used. If not, please specify the artifact version as well.

Maven dependency:

<dependencies>
    <dependency>
        <groupId>com.ritense.valtimo</groupId>
        <artifactId>catalogi-api</artifactId>
    </dependency>
</dependencies>

Gradle dependency:

dependencies {
  implementation("com.ritense.valtimo:catalogi-api")
}

Frontend

A general instruction to add a front-end plugin to the implementation can be found here.

In order to use the Catalogi API plugin in the frontend the following can be added to your app.module.ts:

import { CatalogiApiPluginModule, catalogiApiPluginSpecification } from '@valtimo/plugin';

@NgModule({
  imports: [
      CatalogiApiPluginModule,
  ],
  providers: [
      {
          provide: PLUGIN_TOKEN,
          useValue: [
              catalogiApiPluginSpecification,
          ]
      }
  ]
})

Before the Catalogi API plugin can be used, an authentication plugin is needed. One such authentication plugin is the OpenZaak plugin. Instructions on how to add the OpenZaak plugin can be found here.