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: docs/endpoints/post-identity-buckets.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ You must encrypt all requests using your secret. For details, and code examples
30
30
|`{environment}`| string | Required | Testing (integration) environment: `https://operator-integ.uidapi.com`<br/>Production environment: The best choice depends on where your users are based. For information about how to choose the best URL for your use case, and a full list of valid base URLs, see [Environments](../getting-started/gs-environments.md). |
31
31
32
32
:::note
33
-
The integration environment and the production environment require different <Linkhref="../ref-info/glossary-uid#gl-api-key">API keys</Link>.
33
+
The integration environment and the production environment require different <Linkhref="../ref-info/glossary-uid#gl-api-key">API keys</Link>. For information about getting credentials for each environment, see [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials).
Copy file name to clipboardExpand all lines: docs/endpoints/post-identity-map.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ You must encrypt all requests using your secret. For details, and code examples
41
41
|`{environment}`| string | Required | Testing (integration) environment: `https://operator-integ.uidapi.com`<br/>Production environment: The best choice depends on where your users are based. For information about how to choose the best URL for your use case, and a full list of valid base URLs, see [Environments](../getting-started/gs-environments.md). |
42
42
43
43
:::note
44
-
The integration environment and the production environment require different <Linkhref="../ref-info/glossary-uid#gl-api-key">API keys</Link>.
44
+
The integration environment and the production environment require different <Linkhref="../ref-info/glossary-uid#gl-api-key">API keys</Link>. For information about getting credentials for each environment, see [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials).
Copy file name to clipboardExpand all lines: docs/endpoints/post-optout-status.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ You must encrypt all requests using your secret. For details, and code examples
43
43
|`{environment}`| string | Required | Testing (integration) environment: `https://operator-integ.uidapi.com`<br/>Production environment: The best choice depends on where your users are based. For information about how to choose the best URL for your use case, and a full list of valid base URLs, see [Environments](../getting-started/gs-environments.md). |
44
44
45
45
:::note
46
-
The integration environment and the production environment require different <Linkhref="../ref-info/glossary-uid#gl-api-key">API keys</Link>.
46
+
The integration environment and the production environment require different <Linkhref="../ref-info/glossary-uid#gl-api-key">API keys</Link>. For information about getting credentials for each environment, see [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials).
Copy file name to clipboardExpand all lines: docs/endpoints/post-token-validate.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ You must encrypt all requests using your secret key. For details, and code examp
34
34
|`{environment}`| string | Required | Testing (integration) environment: `https://operator-integ.uidapi.com`<br/>Production environment: The best choice depends on where your users are based. For information about how to choose the best URL for your use case, and a full list of valid base URLs, see [Environments](../getting-started/gs-environments.md). |
35
35
36
36
:::note
37
-
The integration environment and the production environment require different <Linkhref="../ref-info/glossary-uid#gl-api-key">API keys</Link>.
37
+
The integration environment and the production environment require different <Linkhref="../ref-info/glossary-uid#gl-api-key">API keys</Link>. For information about getting credentials for each environment, see [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials).
Copy file name to clipboardExpand all lines: docs/getting-started/gs-credentials.md
+11-3Lines changed: 11 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,19 +9,27 @@ import Link from '@docusaurus/Link';
9
9
10
10
# UID2 Credentials
11
11
12
-
Each UID2 <ahref="../intro#participants">participant</a> needs a set of unique credentials. The set of credentials you need is determined by how you are participating in UID2, as shown in the following table.
12
+
Each UID2 <ahref="../intro#participants">participant</a> needs at least one set of unique credentials. The set of credentials you need is determined by how you are participating in UID2, as shown in the following table.
13
13
14
14
| Audience | Credentials | Integration |
15
15
| :--- | :--- | :--- |
16
16
| Participants using a client-side implementation | Both of the following: <ul><li><Linkhref="../ref-info/glossary-uid#gl-subscription-id">Subscription ID</Link></li><li><Linkhref="../ref-info/glossary-uid#gl-public-key">Public key</Link></li></ul>These two, together, are sometimes called <Linkhref="../ref-info/glossary-uid#gl-client-keypair">client keypair</Link>. | Integrations using one of these: <ul><li>[UID2 Client-Side Integration Guide for Prebid.js](../guides/integration-prebid-client-side.md)</li><li>[Client-Side Integration Guide for JavaScript](../guides/integration-javascript-client-side.md)</li><li>[UID2 Client-Side Integration Guide for Mobile](../guides/integration-mobile-client-side.md)</li></ul> |
17
17
| Participants using a client-server implementation | Both of the following:<ul><li><Linkhref="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key</li><li><Linkhref="../ref-info/glossary-uid#gl-client-secret">Client secret</Link>, a value known only to the participant and the UID2 service</li></ul> | Integrations using one of these: <ul><li>[Client-Server Integration Guide for JavaScript](../guides/integration-javascript-client-server.md)</li><li>[UID2 Client-Server Integration Guide for Prebid.js](../guides/integration-prebid-client-server.md)</li><li>[UID2 Client-Server Integration Guide for Mobile](../guides/integration-mobile-client-server.md)</li></ul> |
18
18
| Participants using a server-side implementation | Both of the following:<ul><li><Linkhref="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key</li><li><Linkhref="../ref-info/glossary-uid#gl-client-secret">Client secret</Link>, a value known only to the participant and the UID2 service</li></ul> | Integrations using one of these: <ul><li>[Publisher Integration Guide, Server-Side](../guides/integration-publisher-server-side.md)</li><li>[Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md)</li></ul> |
19
19
20
+
## Separate Credentials Per Environment/Role
21
+
20
22
If you're using the integration environment as well as the production environment, you'll get a separate set of credentials for each environment. See [Getting Your Credentials](#getting-your-credentials).
21
23
24
+
In addition, in some cases, we recommend, but do not require, that you have a different set of credentials for a different scenario. For example:
25
+
- If you have a website and a mobile app, we recommend having different credentials for each.
26
+
- If you're a data provider, and map data on behalf of clients as well as on your own behalf, you might have separate credentials for each of these activities.
27
+
- If you're a publisher, but also map data on your own behalf, you might have separate credentials for each of these activities.
28
+
29
+
22
30
## Getting Your Credentials
23
31
24
-
The following table shows how you get your credentials, for each [integration approach](../ref-info/ref-integration-approaches.md) and for each [environment](../getting-started/gs-environments.md).
32
+
The following table shows how you get your credentials, for each [integration approach](../ref-info/ref-integration-approaches.md) and each [environment](../getting-started/gs-environments.md).
25
33
26
34
<table>
27
35
<thead>
@@ -98,7 +106,7 @@ Here is some information about API keys and client secrets:
98
106
- Each key has a set of [permissions](gs-permissions.md) that determine the endpoints you can use it on.
99
107
- Each key has a corresponding client secret.
100
108
- Most API endpoints require both API key and client secret for authentication. For details, see [Authentication and Authorization](gs-auth.md).
101
-
- If you're using the integration environment as well as the production environment, you'll receive separate API keys for each environment.
109
+
- If you're using the integration environment as well as the production environment, you'll receive separate API keys for each environment. For details, see [Getting Your Credentials](#getting-your-credentials).
102
110
- The client secret is valid for a specific [environment](gs-environments.md). If you're using both the integration and production environments, you'll get a client secret for each environment.
103
111
104
112
As part of getting your UID2 account set up, we'll give you one or more API keys, each with a corresponding client secret. For details of who to talk to, see [Contact Info](gs-account-setup.md#contact-info).
Copy file name to clipboardExpand all lines: docs/getting-started/gs-environments.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,13 +11,13 @@ import Link from '@docusaurus/Link';
11
11
12
12
Learn about the different environments available, and tips to reduce latency by choosing the best base URL for your integration.
13
13
14
-
## UID2 Testing and Production Environments
14
+
## UID2 Integration and Production Environments
15
15
16
-
The following table lists all current testing and production environments for UID2.
16
+
The following table lists all current integration (also known as testing) and production environments for UID2.
17
17
18
18
| Environment | Cloud Region | Code | Base URL |
19
19
| :--- | :--- | :--- | :--- |
20
-
| Integration Testing| AWS US East (Ohio) |`us-east-2`|`https://operator-integ.uidapi.com`|
20
+
| Integration (for testing)| AWS US East (Ohio) |`us-east-2`|`https://operator-integ.uidapi.com`|
21
21
| Production | Automatically optimized region routing via the <ahref='https://aws.amazon.com/global-accelerator/'>AWS Global Accelerator</a> |`n/a`|`https://global.prod.uidapi.com`|
22
22
| Production | AWS US East (Ohio) |`us-east-2`|`https://prod.uidapi.com`|
23
23
| Production | AWS US West (Oregon) |`us-west-2`|`https://usw.prod.uidapi.com`|
@@ -30,14 +30,14 @@ For example, `https://operator-integ.uidapi.com/v2/token/generate`.
30
30
Notes:
31
31
32
32
- All UID2 endpoints use the same base URL.
33
-
- The integration environment and the production environment require different <Linkhref="../ref-info/glossary-uid#gl-api-key">API keys</Link>.
33
+
- The integration environment and the production environment require different <Linkhref="../ref-info/glossary-uid#gl-api-key">API keys</Link>. For information about getting credentials for each environment, see [Getting Your Credentials](../getting-started/gs-credentials.md#getting-your-credentials).
34
34
- The expiration time of the <Linkhref="../ref-info/glossary-uid#gl-uid2-token">UID2 token</Link> returned by the [POST /token/generate](../endpoints/post-token-generate.md) or [POST /token/refresh](../endpoints/post-token-refresh.md) endpoints is subject to change, but is always significantly shorter in the integration environment than it is in the production environment.
35
35
36
36
## Getting Credentials for Each Environment
37
37
38
38
If you're using the integration environment as well as the production environment, you'll need to get a separate set of credentials for each environment.
39
39
40
-
For details about getting the values you need to access each environment, see [UID2 Credentials](gs-credentials.md).
40
+
For details about getting the values you need to access each environment, see [Getting Your Credentials](gs-credentials.md#getting-your-credentials).
Copy file name to clipboardExpand all lines: docs/guides/dsp-guide.md
-15Lines changed: 0 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,21 +20,6 @@ For a summary of available server-side SDKs, see [SDKs: Summary](../sdks/summary
20
20
If your back end is written in a language not covered by one of the available server-side SDKs, ask your UID2 contact in case there is additional information available to help you. If you're not sure who to ask, see [Contact Info](../getting-started/gs-account-setup.md#contact-info).
21
21
:::
22
22
23
-
## Complete UID2 Account Setup and Configure Account
24
-
25
-
To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page.
26
-
27
-
When initial account setup is complete, you'll receive instructions and a link to access the UID2 Portal, where you can create your credentials and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md).
28
-
29
-
You'll need to set up these values, in the UID2 Portal on the [API Keys](../portal/api-keys.md) page:
30
-
31
-
- <Linkhref="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key
32
-
- <Linkhref="../ref-info/glossary-uid#gl-client-secret">Client secret</Link>, a value known only to the participant and the UID2 service
33
-
34
-
:::important
35
-
It's very important that you keep these values secure. For details, see [Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret).
36
-
:::
37
-
38
23
## Integration Steps
39
24
40
25
The following describes the integration workflow for DSP to support UID2 as part of RTB, which consists of two major steps:
Copy file name to clipboardExpand all lines: docs/guides/integration-advertiser-dataprovider-endpoints.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ For a summary of all integration options and steps for advertisers and data prov
20
20
21
21
To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page.
22
22
23
-
When initial account setup is complete, you'll receive instructions and a link to access the UID2 Portal, where you can create your credentials and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md).
23
+
When initial account setup is complete, you'll receive instructions and a link to access the UID2 Portal, where you can create your [credentials](../getting-started/gs-credentials.md) for the production environment and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md).
24
24
25
25
You'll need to set up these values, in the UID2 Portal on the [API Keys](../portal/api-keys.md) page:
Copy file name to clipboardExpand all lines: docs/guides/integration-advertiser-dataprovider-overview.md
-15Lines changed: 0 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,21 +26,6 @@ There are other ways that you can use UID2, outside these use cases. These are j
26
26
| Send in conversions | Send UID2s as conversion information | Use conversion information for measurement (attribution) or for retargeting via API or pixels. |
27
27
| Receive graph data | Receive UID2s from graph/data providers via API or pixels | Build graph data. |
28
28
29
-
## Complete UID2 Account Setup and Configure Account
30
-
31
-
To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page.
32
-
33
-
When initial account setup is complete, you'll receive instructions and a link to access the UID2 Portal, where you can create your credentials and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md).
34
-
35
-
You'll need to set up these values, in the UID2 Portal on the [API Keys](../portal/api-keys.md) page:
36
-
37
-
- <Linkhref="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key
38
-
- <Linkhref="../ref-info/glossary-uid#gl-client-secret">Client secret</Link>, a value known only to the participant and the UID2 service
39
-
40
-
:::important
41
-
It's very important that you keep these values secure. For details, see [Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret).
42
-
:::
43
-
44
29
## High-Level Steps
45
30
46
31
At a high level, the steps for advertisers and data providers integrating with UID2 are as follows:
Copy file name to clipboardExpand all lines: docs/guides/integration-aws-entity-resolution.md
-15Lines changed: 0 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,21 +33,6 @@ The following table summarizes the functionality available with the AWS Entity R
33
33
| :--- | :--- | :--- | :--- | :--- |
34
34
| No | No | No | No | Yes |
35
35
36
-
## Complete UID2 Account Setup and Configure Account
37
-
38
-
To integrate with UID2, you'll need to have a UID2 account. If you haven't yet created an account, first follow the steps described on the [Account Setup](../getting-started/gs-account-setup.md) page.
39
-
40
-
When initial account setup is complete, you'll receive instructions and a link to access the UID2 Portal, where you can create your credentials and configure additional values, if needed. For details, see [Getting Started with the UID2 Portal](../portal/portal-getting-started.md).
41
-
42
-
You'll need to set up these values, in the UID2 Portal on the [API Keys](../portal/api-keys.md) page:
43
-
44
-
- <Linkhref="../ref-info/glossary-uid#gl-api-key">API key</Link>, also called a client key
45
-
- <Linkhref="../ref-info/glossary-uid#gl-client-secret">Client secret</Link>, a value known only to the participant and the UID2 service
46
-
47
-
:::important
48
-
It's very important that you keep these values secure. For details, see [Security of API Key and Client Secret](../getting-started/gs-credentials.md#security-of-api-key-and-client-secret).
49
-
:::
50
-
51
36
## Integration Summary
52
37
53
38
The following table summarizes the steps to integrate with UID2 using AWS Entity Resolution.
0 commit comments