https://github.com/joubertredrat/matomo-protecttrackid

A Matomo plugin that protect track ID
https://github.com/joubertredrat/matomo-protecttrackid

hash matomo matomo-plugin matomo-tracking matomo-ui matomo-web-analytics piwik-plugin plugin

Last synced: 11 days ago
JSON representation

A Matomo plugin that protect track ID

• Host: GitHub
• URL: https://github.com/joubertredrat/matomo-protecttrackid
• Owner: joubertredrat
• License: mit
• Created: 2016-06-21T12:38:51.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-04-18T23:38:55.000Z (7 months ago)
• Last Synced: 2024-04-19T00:27:40.673Z (7 months ago)
• Topics: hash, matomo, matomo-plugin, matomo-tracking, matomo-ui, matomo-web-analytics, piwik-plugin, plugin
• Language: PHP
• Homepage: https://plugins.matomo.org/ProtectTrackID
• Size: 988 KB
• Stars: 19
• Watchers: 0
• Forks: 7
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# Matomo ProtectTrackID Plugin

## Description

Provides a option to protect idSite using hash instead default numeric. This plugin was formerly Piwik Protect TrackID.

## Dependencies

* PHP 7.3.5 or above

* bcmath, gmp and mbstring extensions

## Support

If you need support, you can open a new thread in [Matomo Plugins Forum](https://forum.matomo.org/c/plugins-platform/11) or [opening a issue](https://github.com/joubertredrat/Matomo-ProtectTrackID/issues/new), any other ways of contact will be rejected.

## API

This plugin have option to get hashed id from idSite. This can be useful for automations. The method for API request is `ProtectTrackID.getHashedId` and required field is `idSite`.

Example of request

```bash

curl -s --request GET --url 'http://0.0.0.0:50003/?module=API&method=ProtectTrackID.getHashedId&token_auth=d367fc84b4198c977cc72af45eb5a81b&idSite=1&format=JSON'

```

Example of response

```json

{

  "value": "32BGpzwv5mNDEKv"

}

```

## FAQ

__Why isn't good to change configuration more times?__

Because if you change configurations (`base string`, `salt` and `length`), hashed string will change too, then old hashes will not work. ONLY change salt if you will change all JavaScript Tracking Code or Image Tracking Link after change configuration. Then is **HIGHT RECOMMENDED to set configurations ONLY ONE TIME**.

__How to I config plugin?__

On Administration > Plugin Settings. For plugin work, is required all configurations defined, if only one or two defined, plugin will not work.

Plugin need 3 configurations, `base string`, `salt` and `length`.

`base string` is string used to generate hash. Example, if you set `ABCDEFGHIJKLMNOPQRSTUVXWYZ`, plugin will use only this characters for build hash.

`salt` is a radom string key for generate hash with `base string` and `length` configurations.

`length` is a hash string size. If you set `10` as example, plugin will generete hash with 10 characters defined on `base string`.

__Why JavaScript Tracking Code and Image Tracking Link is blank?__

This plugin will hash siteId by configurations, but if you define small `base string`, `salt` or `length`, plugin wont haven't combinations enough for create hash string. Then you need incresease `base string`, `salt` and/or `length`.

__If I install this plugin I need to change track code for all sites or old track code still will work?__ Thanks [@yurgon](https://github.com/yurgon) for the question.

You can install and set plugin configuration, old tracking code will work without problems because plugin validates tracking `siteId` with plugin settings to set if `siteId` is hashed id or normal numeric id. But is necessary attention, because although old tracking code will continue work, Matomo will display only new tracking code.

## Changelog

See [releases](https://github.com/joubertredrat/Matomo-ProtectTrackID/releases). This project follows the guidelines of [semantic versioning](http://semver.org).

## Support

Want support? Check our issues in https://github.com/joubertredrat/Matomo-ProtectTrackID/issues