Architecture

PrivacyID integrates into multiple layers of your website in order provide maximum compatibility with evolving browser privacy standards. The diagram below illustrates the various layers involved and how they interact with each other. Only two layers require integration via code (3 & 5) and one layer (4) via a network configuration. Once the solution has been integrated, simple JavaScript APIs can be invoked to provide user identifications services to third-party scripts (7).

Integration Layers

1. PrivacyID Servers Fanplayr’s global infrastructure that powers PrivacyID.

2. Web Server Your web server(s) which handle all requests for your website. This guide uses https://your-website.com as an example url for your website.

3. API Endpoint — (Integration Required) You’ll implement a new endpoint on your web server which will handle communication between the browser and the PrivacyID servers. It will also persist the user identity in a secure cookie which can only be accessed by your servers and is not visible to client-side JavaScript. Later in this guide we’ll provide templates for many different languages and server environments which will help you implement this step quickly.

4. DNS Entry — (Integration Required) You’ll create a CNAME DNS entry which will point a subdomain of your website to the PrivacyID servers. This will allow the full PrivacyID JavaScript Library (6) to be loaded through your domain to ensure that it maintains compatibility with browser privacy standards. This guide uses pid.your-website.com as an example for this subdomain.

5. PrivacyID Embed Snippet — (Integration Required) You’ll include this JavaScript code on every page of your website where you need to identify users. This snippet will handle initialization of the PrivacyID library (6) and allow you to specify the endpoint (3) and subdomain (4) you created.

6. PrivacyID Library Handles communication with the API endpoint (3) you created on your web server and responds to third-party requests (7) for the user’s identity.

7. Third-Party Clients — (Integration Required) Clients and services will obtain unique and consistent user identifiers by making simple requests to the PrivacyID JavaScript API.