Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
8edf584
update js-sdk to use updated variables
Oct 28, 2025
9ed1029
make variables names more general
Oct 28, 2025
6d28f2e
update final variables names for js sdk after testing
Oct 28, 2025
8fcf4e2
update env.sample with new names
Oct 28, 2025
a02803b
push additonal variables for google secure signals and update env files
Oct 28, 2025
26efdeb
update local variable names to match env variables
Oct 28, 2025
73fc47c
update google secure readmes to discuss both uid and euid
Oct 28, 2025
4ea5b3f
update local variable name to match
Oct 28, 2025
11bbe83
update client-server uid2 local variable name for pure uid2
Oct 28, 2025
03a547d
update render bug in server side secure signal after update
Oct 28, 2025
d5ff29e
extract reused sdk variable to be more global
Oct 28, 2025
d3e9390
update productName to identityName for improved readability and test …
Oct 28, 2025
e91e259
Remove ui default values and remove unnecessary sdk defintions
Oct 28, 2025
9f0905e
update product name to identity name in env sample files
Oct 28, 2025
90f1aad
remove euid portal reference and improve definition an dinstructions
Oct 28, 2025
ed3d6e5
update to use shorthand syntax for same js/ts variable names
Oct 28, 2025
f2ead01
remove uid2 hardcoded referenece in function name in server side google
Oct 28, 2025
8a17e06
add additonal euid referencees in testing application section in readmes
Oct 28, 2025
55f3067
update readmes to clarify distinction between uid2 and euid in titles
Oct 28, 2025
22fc266
update function names with uid2 and fix back to home page bug in gss …
Oct 28, 2025
bdc8ea2
update port numbers in readmes
Oct 28, 2025
3de450c
finalize env sample file and clarify instructions
Oct 28, 2025
119bc71
Update final intro line seperating uid2 and euid
Oct 28, 2025
89ec299
create sdk object with callback array if does not exist
Oct 29, 2025
5bb90f6
update react logic and env sample pages to include local environments
Oct 29, 2025
ed2810a
update sample pages with more clarifications
Oct 29, 2025
86731b2
remove partner portal wording in env sample uid2
Oct 29, 2025
8492374
clean up logic to determine google secure signal provider in react app
Oct 29, 2025
5acb97a
Revert prebid changes - will be handled in separate ticket
Oct 29, 2025
9ab996f
update readmes to include correct port numbers
Oct 29, 2025
9ddbd2d
clean up google secure loading logic in react app
Oct 29, 2025
697880d
add back ad tag and fix read me instances of partner portal
Oct 29, 2025
15a1fb6
update return logic for client server flow
Oct 29, 2025
10ef7cd
remove all aprtner portal references in the readmes
Oct 29, 2025
d16f545
add back helpful comments to docker commands in readmes
Oct 29, 2025
53ac12f
add back docker comman path for down instructions
Oct 29, 2025
e5eca85
remove portal refs in readme
Oct 29, 2025
6cabfee
add back disconnect line for cleaner reload
Oct 29, 2025
9216f10
remove portal reference in env
Oct 29, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 0 additions & 41 deletions .env.sample

This file was deleted.

60 changes: 60 additions & 0 deletions .env.sample.euid
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# ==============================================================================
# EUID Environment Configuration
# ==============================================================================
# This file provides default EUID integration settings.
# Edit the first section with your EUID credentials and keys.
# The values in the bottom section are EUID-specific constants and should NOT
# be changed unless you are configuring for a different EUID environment.
#
# ⚠️ EDIT THESE VALUES FIRST - Your EUID Credentials ⚠️
# ==============================================================================

# Server-Side & Client-Server Examples - Provided by your EUID integration representative
UID_API_KEY="your-api-key"
UID_CLIENT_SECRET="your-client-secret"

# Server-Side Examples - Any secure random string for session encryption
SESSION_KEY="your-session-key-here"

# Client-Side Token Generation (CSTG) - Provided by your EUID integration representative
UID_CSTG_SERVER_PUBLIC_KEY="your-euid-server-public-key"
UID_CSTG_SUBSCRIPTION_ID="your-euid-subscription-id"

# React Client-Side Examples - Provided by your EUID integration representative
Comment thread
eiman-eltigani-ttd marked this conversation as resolved.
# Note: These are the same values as the variables above, prefixed with REACT_APP_
# for use in React applications. Use your same EUID credentials from above.
REACT_APP_UID_CSTG_SERVER_PUBLIC_KEY="your-euid-server-public-key"
REACT_APP_UID_CSTG_SUBSCRIPTION_ID="your-euid-subscription-id"

# ==============================================================================
# EUID Constants (Do NOT change unless working with different EUID environment)
# ==============================================================================
Comment thread
ashleysmithTTD marked this conversation as resolved.

# API Endpoints (Integration environment)
UID_SERVER_BASE_URL="https://integ.euid.eu" # ← For local development, use: http://host.docker.internal:8080
UID_CLIENT_BASE_URL="https://integ.euid.eu" # ← For local development, use: http://localhost:8080

# JavaScript SDK Configuration
UID_JS_SDK_URL="https://cdn.integ.euid.eu/euid-sdk-4.0.1.js"
UID_JS_SDK_NAME="__euid"

# Google Secure Signals Configuration
UID_SECURE_SIGNALS_SDK_URL="https://cdn.integ.euid.eu/euidSecureSignal.js"
UID_SECURE_SIGNALS_STORAGE_KEY="_GESPSK-euid.eu"

# Prebid Configuration
UID_STORAGE_KEY="__euid_advertising_token"

# UI Display Configuration
IDENTITY_NAME="EUID"
DOCS_BASE_URL="https://euid.eu/docs"


# React Constants (for React-based examples)
REACT_APP_UID_CLIENT_BASE_URL="https://integ.euid.eu" # ← For local development, use: http://localhost:8080
REACT_APP_UID_JS_SDK_NAME="__euid"
REACT_APP_UID_SECURE_SIGNALS_SDK_URL="https://cdn.integ.euid.eu/euidSecureSignal.js"
REACT_APP_UID_SECURE_SIGNALS_STORAGE_KEY="_GESPSK-euid.eu"
REACT_APP_IDENTITY_NAME="EUID"
REACT_APP_DOCS_BASE_URL="https://euid.eu/docs"
Comment thread
eiman-eltigani-ttd marked this conversation as resolved.

58 changes: 58 additions & 0 deletions .env.sample.uid2
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# ==============================================================================
# UID2 Environment Configuration
# ==============================================================================
# This file provides default UID2 integration settings.
# Edit the first section with your UID2 credentials and keys.
# The values in the bottom section are UID2-specific constants and should NOT
# be changed unless you are configuring for a different UID2 environment.
#
# ⚠️ EDIT THESE VALUES FIRST - Your UID2 Credentials ⚠️
# ==============================================================================

# Server-Side & Client-Server Examples
UID_API_KEY="your-api-key"
UID_CLIENT_SECRET="your-client-secret"

# Server-Side Examples - Any secure random string for session encryption
SESSION_KEY="your-session-key-here"

# Client-Side Token Generation (CSTG)
UID_CSTG_SERVER_PUBLIC_KEY="UID2-X-I-MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEo+jcPlk8GWn3iG0R5Il2cbFQI9hR3TvHxaBUKHl5Vh+ugr+9uLMiXihka8To07ETFGghEifY96Hrpe5RnYko7Q=="
UID_CSTG_SUBSCRIPTION_ID="DMr7uHxqLU"

# React Client-Side Examples
# Note: These are the same values as the variables above, prefixed with REACT_APP_
# for use in React applications. Use your same UID2 credentials from above.
REACT_APP_UID_CSTG_SERVER_PUBLIC_KEY="UID2-X-I-MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEo+jcPlk8GWn3iG0R5Il2cbFQI9hR3TvHxaBUKHl5Vh+ugr+9uLMiXihka8To07ETFGghEifY96Hrpe5RnYko7Q=="
REACT_APP_UID_CSTG_SUBSCRIPTION_ID="DMr7uHxqLU"

# ==============================================================================
# UID2 Constants (Do NOT change unless working with different UID2 environment)
# ==============================================================================

# API Endpoints (Integration environment)
UID_SERVER_BASE_URL="https://operator-integ.uidapi.com" # ← For local development, use: http://host.docker.internal:8080
UID_CLIENT_BASE_URL="https://operator-integ.uidapi.com" # ← For local development, use: http://localhost:8080

# JavaScript SDK Configuration
UID_JS_SDK_URL="https://cdn.integ.uidapi.com/uid2-sdk-4.0.1.js"
UID_JS_SDK_NAME="__uid2"

# Google Secure Signals Configuration
UID_SECURE_SIGNALS_SDK_URL="https://cdn.integ.uidapi.com/uid2SecureSignal.js"
UID_SECURE_SIGNALS_STORAGE_KEY="_GESPSK-uidapi.com"

# Prebid Configuration
UID_STORAGE_KEY="__uid2_advertising_token"

# UI Display Configuration
IDENTITY_NAME="UID2"
DOCS_BASE_URL="https://unifiedid.com/docs"

# React Constants (for React-based examples)
REACT_APP_UID_CLIENT_BASE_URL="https://operator-integ.uidapi.com" # ← For local development, use: http://localhost:8080
REACT_APP_UID_JS_SDK_NAME="__uid2"
REACT_APP_UID_SECURE_SIGNALS_SDK_URL="https://cdn.integ.uidapi.com/uid2SecureSignal.js"
REACT_APP_UID_SECURE_SIGNALS_STORAGE_KEY="_GESPSK-uidapi.com"
REACT_APP_IDENTITY_NAME="UID2"
REACT_APP_DOCS_BASE_URL="https://unifiedid.com/docs"
39 changes: 28 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,15 +77,32 @@ docker-compose up -d --build prebid-client

### Environment Configuration

Edit the `.env` file in the base directory to configure your UID2 settings:
```
# UID2 Configuration for all services
UID2_BASE_URL="http://localhost:8080"
SERVER_PUBLIC_KEY="your-public-key"
SUBSCRIPTION_ID="your-subscription-id"

# Additional variables for client-server example
UID2_API_KEY="your-api-key"
UID2_CLIENT_SECRET="your-client-secret"
```
This repository includes sample environment files for both UID2 and EUID configurations:

- **`.env.sample.uid2`** - UID2 configuration template
- **`.env.sample.euid`** - EUID configuration template

**To get started:**

1. Copy the appropriate sample file to `.env`:
```bash
# For UID2
cp .env.sample.uid2 .env

# For EUID
cp .env.sample.euid .env
```

2. Update the `.env` file with your credentials:
- Replace `your-api-key` with your actual API key
- Replace `your-client-secret` with your actual client secret
- Update other placeholder values as needed

The sample files include all necessary environment variables for running the examples, including configuration for:
- Core API endpoints
- JavaScript SDK settings
- Google Secure Signals integration
- Prebid integration
- React client examples
- UI/Display preferences

Loading