> For the complete documentation index, see [llms.txt](https://docs.valtimo.nl/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.valtimo.nl/fundamentals/getting-started/modules/zgw/notificaties-api.md).

# Notificaties API

## Dependencies

In order to use the Notificaties API, the Notificaties 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](/fundamentals/getting-started/modules/core/valtimo-dependency-versions.md) module is used. If not, please specify the artifact version as well.

#### Maven dependency:

```xml
<dependencies>
    <dependency>
        <groupId>com.ritense.valtimo</groupId>
        <artifactId>notificaties-api</artifactId>
    </dependency>
</dependencies>
```

#### Gradle dependency:

```kotlin
dependencies {
  implementation("com.ritense.valtimo:notificaties-api")
}
```

#### Disabling subscriptions:

In order to prevent new subscriptions from being created in the Notificaties API, the following property can be set:

```yaml
valtimo.zgw.register-abonnementen: true
```

### Frontend

A general instruction to add a front-end plugin to the implementation can be found in the [plugin documentation](/fundamentals/getting-started/modules/core/plugin.md#adding-a-front-end-plugin-to-the-implementation).

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

```typescript
import { NotificatiesApiPluginModule, notificatiesApiPluginSpecification } from '@valtimo/plugin';

@NgModule({
  imports: [
      NotificatiesApiPluginModule,
  ],
  providers: [
      {
          provide: PLUGIN_TOKEN,
          useValue: [
              notificatiesApiPluginSpecification,
          ]
      }
  ]
})
```

Before the Notificaties API plugin can be used, an authentication plugin is needed. One such authentication plugin is the Notificaties API authentication plugin. Instructions on how to add this plugin can be found in the [Notificaties API authentication documentation](/fundamentals/getting-started/modules/zgw/notificaties-api-authentication.md).