EDP Faros

3min

SummaryEDP Faros uses tags to unlock Purple contents.
It differentiates between basic ("no subscription but logged in") and full subscriptions ("logged in and subscribed") based on the identifier of the EDP subscription.
Separate tags can be used to mark contents for basic and full subscriptions.

Configuration parametersParameter name
Type
Description
URL
String
Server URL of the entitlement REST interface, e.g. https://login-test.mediengruppe-mitteldeutschland.de/cre-1.0
Client Secret
String
﻿
Basic subscription identifier
﻿
﻿
Full subscription identifier
﻿
﻿
Tags with login
String
Comma-separated list of tags of newsfeed articles accessible after login without subscription
Tags with subscriptioninfo

String
Comma-separated list of tags of newsfeed articles accessible after login with subscription
Username Regex
String (regular expression)
Regular expression the username must match.
HubSpot API URL
String
URL of the HubSpot API
HubSpot API Token
String
Token for the HubSpot API, set to "-" to switch the HubSpot notification off.
HubSpot Subscription IDs
String
IDs of subscriptions for any new user registers (separated by commas)
HubSpot Subscription Legal Basis (Code)
String
Code of the legal basis a user subscribes to
HubSpot Subscription Legal Basis (Explanation)
String
Explanation of the legal basis a user subscribes to
Subscription Name Regex
String (regular expression)
Regular expression subscription names must match for HubSpot and statistics processing
HubSpot Subscription Name Mappings
String (JSON)
JSON with mapping information between EDP and HubSpot subscription names
HubSpot Interval (Minutes)
Number
Minimum interval of two HubSpot notifications
Token Validity in Minutes
Number
Number of Minutes a token should be valid.
Subscription Info Retrieval Interval (Minutes)
Number
Minimum interval of two subscription information retrievals
Save user id
Boolean
The user id can be used to report exact download numbers
Download export filter
String
Comma-separated list: Users, whose ID includes one of these values, are ignored on the download export
Cache Validity in Minutes
Number
Number of minutes a token is considered fresh. When this time is reached, the token is considered invalid to force a refresh and update of its properties.
﻿

Updated 23 Mar 2023

Did this page help you?

Yes

CeleraOne

Plenigo

Docs powered by archbee

TABLE OF CONTENTS

Summary

Configuration parameters

Parameter name	Type	Description
URL	String	Server URL of the entitlement REST interface, e.g. https://login-test.mediengruppe-mitteldeutschland.de/cre-1.0
Client Secret	String
Basic subscription identifier
Full subscription identifier
Tags with login	String	Comma-separated list of tags of newsfeed articles accessible after login without subscription
Tags with subscriptioninfo	String	Comma-separated list of tags of newsfeed articles accessible after login with subscription
Username Regex	String (regular expression)	Regular expression the username must match.
HubSpot API URL	String	URL of the HubSpot API
HubSpot API Token	String	Token for the HubSpot API, set to "-" to switch the HubSpot notification off.
HubSpot Subscription IDs	String	IDs of subscriptions for any new user registers (separated by commas)
HubSpot Subscription Legal Basis (Code)	String	Code of the legal basis a user subscribes to
HubSpot Subscription Legal Basis (Explanation)	String	Explanation of the legal basis a user subscribes to
Subscription Name Regex	String (regular expression)	Regular expression subscription names must match for HubSpot and statistics processing
HubSpot Subscription Name Mappings	String (JSON)	JSON with mapping information between EDP and HubSpot subscription names
HubSpot Interval (Minutes)	Number	Minimum interval of two HubSpot notifications
Token Validity in Minutes	Number	Number of Minutes a token should be valid.
Subscription Info Retrieval Interval (Minutes)	Number	Minimum interval of two subscription information retrievals
Save user id	Boolean	The user id can be used to report exact download numbers
Download export filter	String	Comma-separated list: Users, whose ID includes one of these values, are ignored on the download export
Cache Validity in Minutes	Number	Number of minutes a token is considered fresh. When this time is reached, the token is considered invalid to force a refresh and update of its properties.