You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-2Lines changed: 25 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
The UID 2 Project is subject to Tech Lab IPR’s Policy and is managed by the IAB Tech Lab Addressability Working Group and Privacy & Rearc Commit Group. Please review the governance rules [here](https://github.com/IABTechLab/uid2-core/blob/master/Software%20Development%20and%20Release%20Procedures.md).
4
4
5
5
## Who is this SDK for?
6
-
This SDK simplifies integration with UID2 for Publishersand DSPs, as described in the [UID2 Integration Guides](https://github.com/UnifiedID2/uid2docs/blob/main/api/v2/guides/README.md).
6
+
This SDK simplifies integration with UID2 for Publishers, DSPs, and UID Sharers, as described in the [UID2 Integration Guides](https://github.com/IABTechLab/uid2docs/blob/main/api/v2/guides/summary-guides.md).
7
7
8
8
## Requirements
9
9
@@ -19,7 +19,7 @@ Add this dependency to your project's POM:
19
19
<dependency>
20
20
<groupId>com.uid2</groupId>
21
21
<artifactId>uid2-client</artifactId>
22
-
<version>4.0.0</version>
22
+
<version>4.1.2</version>
23
23
</dependency>
24
24
```
25
25
@@ -120,3 +120,26 @@ If you're using [server-only integration](https://github.com/UnifiedID2/uid2docs
6. You should then store `tokenRefreshResponse.getIdentityJsonString()` in the user's session. If the user has opted out, this method will return null, indicating that the user's identity should be removed from their session. (Optout can be confirmed via `tokenRefreshResponse.isOptout()`.)
123
+
124
+
## Usage for UID Sharers
125
+
126
+
A UID Sharer is a participant that wants to share UID2s or EUIDs with another participant. Raw UIDs must be encrypted into UID tokens before sending them to another participant. See com.uid2.client.test.IntegrationExamples (runSharingExample method) for an example usage.
127
+
128
+
1. Use UID2ClientFactory.create() to create an IUID2Client reference.
129
+
130
+
`private final IUID2Client client = UID2ClientFactory.create(UID2_BASE_URL, UID2_API_KEY, UID2_SECRET_KEY);`
131
+
2. Call IUID2Client.refresh: once at startup, and then periodically (eg every hour):
0 commit comments