PHPackages                             heimrichhannot/contao-privacy-api-bundle - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. heimrichhannot/contao-privacy-api-bundle

ActiveContao-bundle

heimrichhannot/contao-privacy-api-bundle
========================================

This bundle acts as a bridge between heimrichhannot/contao-privacy and heimrichhannot/contao-api-bundle in order to offer an API for the privacy module.

1.2.1(4y ago)040proprietaryPHPPHP >=7.1CI failing

Since Sep 20Pushed 4y ago5 watchersCompare

[ Source](https://github.com/heimrichhannot/contao-privacy-api-bundle)[ Packagist](https://packagist.org/packages/heimrichhannot/contao-privacy-api-bundle)[ RSS](/packages/heimrichhannot-contao-privacy-api-bundle/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependencies (9)Versions (9)Used By (0)

Contao Privacy API Bundle
=========================

[](#contao-privacy-api-bundle)

This bundle acts as a bridge between [heimrichhannot/contao-privacy](https://github.com/heimrichhannot/contao-privacy) and [heimrichhannot/contao-api-bundle](https://github.com/heimrichhannot/contao-api-bundle) in order to offer an API for the privacy module.

Installation
------------

[](#installation)

Install via composer: `composer require heimrichhannot/contao-privacy-api-bundle` and update your database.

Features
--------

[](#features)

- offers two endpoints for privacy-related interactions: opt-in and opt-out
- calls to this endpoints result in protocol entries to be made in the protocol archive (see [heimrichhannot/contao-privacy](https://github.com/heimrichhannot/contao-privacy) for more detail on that)

Usage
-----

[](#usage)

1\. After installation create a privacy protocol archive as usual (see [heimrichhannot/contao-privacy](https://github.com/heimrichhannot/contao-privacy) for more detail on that)

2\. Now navigate to the "Apps" in the contao section "API" on the left and create your opt-in endpoint. An example for a double opt-in app is given in the following image:

*HINT: Opt-out is done in a similar way.*

[![alt preview](docs/opt-in-app.png)](docs/opt-in-app.png)

3\. After that you can do an opt-in using the following 2 steps:

3.1. Do a POST request to `http://example.org/api/login/user` (or `http://example.org/api/login/member` if you like to auth via Contao members) as described in [heimrichhannot/contao-api-bundle](https://github.com/heimrichhannot/contao-api-bundle):

`curl --user user@:password -H "Content-Type: application/json" -X POST http://example.org/api/login/user`

3.2. The response of the request above contains your auth token. Use this to call the api endpoint you just created:

`curl --header "Authorization: Bearer " -H "Content-Type: application/json" -X POST -d "{"gender":"male", "firstname":"John", "email":"john.doe@example.org"}" http://example.org/api/resource/privacy_protocol_entry_opt_in?key=`

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community5

Small or concentrated contributor base

Maturity62

Established project with proven stability

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~142 days

Recently: every ~248 days

Total

8

Last Release

1802d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/28ad3224d8727b622ebd229840eea6b9dbcb83eb0bd609e6ce65b614830ff538?d=identicon)[digitales@heimrich-hannot.de](/maintainers/digitales@heimrich-hannot.de)

###  Code Quality

TestsPHPUnit

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/heimrichhannot-contao-privacy-api-bundle/health.svg)

```
[![Health](https://phpackages.com/badges/heimrichhannot-contao-privacy-api-bundle/health.svg)](https://phpackages.com/packages/heimrichhannot-contao-privacy-api-bundle)
```

###  Alternatives

[codefog/contao-haste

haste extension for Contao Open Source CMS

42650.8k139](/packages/codefog-contao-haste)[madeyourday/contao-rocksolid-custom-elements

Create your own, nestable content elements using a modular system. End the WYSIWYG chaos with your own content elements.

50341.9k12](/packages/madeyourday-contao-rocksolid-custom-elements)[contao/manager-bundle

Provides the Contao Managed Edition

181.3M61](/packages/contao-manager-bundle)[codefog/contao-news_categories

News Categories bundle for Contao Open Source CMS

3183.3k6](/packages/codefog-contao-news-categories)[terminal42/contao-node

Node bundle for Contao Open Source CMS

3172.5k4](/packages/terminal42-contao-node)[terminal42/contao-folderpage

Provides a new page type for Contao that allows you to group pages into folders.

18147.9k9](/packages/terminal42-contao-folderpage)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)