Skip to content

Commit

Permalink
docs: add anonymized user data API responses
Browse files Browse the repository at this point in the history
Add anonymized examples of Deezer user data API responses for Free and
Family HiFi accounts as reference documentation. All identifiers, tokens,
and personal information have been replaced with synthetic data while
maintaining the original structure.
  • Loading branch information
roderickvd committed Dec 23, 2024
1 parent c4760e8 commit 8cfbf19
Show file tree
Hide file tree
Showing 4 changed files with 1,720 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ and [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
## [Unreleased]

### Added
- [docs] Add anonymized API response fixtures as reference documentation
- [gateway] Check for Free accounts and prevent connecting due to audio ads limitation

### Changed
Expand Down
35 changes: 35 additions & 0 deletions tests/fixtures/gateway/user_data/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# User Data API Response Fixtures

This directory contains examples of Deezer user data API responses that have been thoroughly anonymized.

**IMPORTANT - ANONYMIZED DATA**

All data in these files has been completely anonymized:
- All tokens, IDs, and authentication data are fake and cannot be used to authenticate
- Personal information has been replaced with dummy data
- Device identifiers have been replaced with example values
- All unique identifiers have been changed to non-existent values

**Any attempt to use this data for authentication or user identification would be futile - these are reference examples only.**

## File Overview

- `free.json`: Response for a free-tier account that has never used the web player
- `family_hifi.json`: Response for a Family HiFi subscription with web player history

## Response Characteristics

The responses vary in several ways:
- Different fields are present depending on the user's subscription level
- Additional fields appear if the user has previously used the web player
- Some fields may be empty or missing entirely depending on the user's history with the service

### Important Notes

- A `USER_ID` of "0" indicates no user is logged in (invalid session)
- All identifiers, tokens, and personal information in these fixtures have been anonymized while maintaining the original format and structure
- The structure of the responses is authentic, but all values are synthetic

## Purpose

These fixtures document the structure and variations of the Deezer user data API responses, helping developers understand the possible fields and values they might encounter when implementing API integrations. They are provided for reference only and cannot be used for actual authentication or user identification.
Loading

0 comments on commit 8cfbf19

Please sign in to comment.