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
Change the instruction on auth and update links (#1101)
* Modify the instruction on project authentication.
* As the Teams and Permissions guide will be deleted, and
the Identity & Access Management Developer Guide will be used instead,
update the links.
Relates-To: OLPEDGE-2364, OLPEDGE-2366
Signed-off-by: Halyna Dumych <[email protected]>
Copy file name to clipboardExpand all lines: docs/GettingStartedGuide.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
@@ -17,7 +17,7 @@ For more information, see the [Data User Guide](https://developer.here.com/olp/d
17
17
18
18
To work with catalog or service requests to the HERE platform, you need to get authentication and authorization credentials.
19
19
20
-
You can authenticate to the HERE platform within your application with the platform credentials available on the HERE platform Portal by means of the Data SDK for C++ authentication library. For instructions on how to get credentials, see the [related section](https://developer.here.com/olp/documentation/access-control/user-guide/topics/get-credentials.html) in the Terms and Permissions User Guide.
20
+
You can authenticate to the HERE platform within your application with the platform credentials available on the HERE Portal by means of the Data SDK for C++ authentication library. For the available authentication options, see the [Identity & Access Management Developer Guide](https://developer.here.com/documentation/identity-access-management/dev_guide/index.html).
Copy file name to clipboardExpand all lines: docs/authenticate.md
+41-18Lines changed: 41 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,20 @@
1
1
# Authenticate to the HERE Platform
2
2
3
-
To authenticate to the HERE platform and start working with HERE Data SDK for C++, you need to get an access token. You can receive it using a [default token provider](#authenticate-using-a-default-token-provider), [project authentication](#authenticate-using-project-authentication), or [federated credentials](#authenticate-using-federated-credentials)
3
+
To authenticate to the HERE platform and start working with HERE Data SDK for C++, you need to get an access token. You can receive it using a [default token provider](#authenticate-using-a-default-token-provider), [project authentication](#authenticate-using-project-authentication), or [federated credentials](#authenticate-using-federated-credentials).
4
+
5
+
> Note: Keep your credentials secure and do not disclose them. Make sure that your credentials are not stored in a way that enables others to access them.
4
6
5
7
## Authenticate using a default token provider
6
8
7
9
1. Get your platform credentials.
8
10
9
-
For instructions, see the [Get Credentials](https://developer.here.com/olp/documentation/access-control/user-guide/topics/get-credentials.html) section in the Terms and Permissions User Guide.
11
+
For instructions, see the [Register Your Application](https://developer.here.com/documentation/identity-access-management/dev_guide/topics/plat-token.html#step-1-register-your-application) section in the Identity & Access Management Developer Guide.
10
12
11
13
You get the `credentials.properties` file.
12
14
13
15
2. Initialize the authentification settings using the **here.access.key.іd** and **here.access.key.secret** from the `credentials.properties` file as `kKeyId` and `kKeySecret` respectively.
14
16
15
-
> Note: You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://developer.here.com/documentation/sdk-cpp/api_reference/classolp_1_1authentication_1_1AuthenticationCredentials.html#a6bfd8347ebe89e45713b966e621dccdd).
17
+
> Note: You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://developer.here.com/documentation/sdk-cpp/api_reference/classolp_1_1authentication_1_1_authentication_credentials.html#a6bfd8347ebe89e45713b966e621dccdd).
@@ -30,40 +32,61 @@ To authenticate to the HERE platform and start working with HERE Data SDK for C+
30
32
31
33
You get an access token.
32
34
33
-
You can use the `AuthenticationSettings` object to create the `OlpClientSettings` object. For more information, see the [related](https://developer.here.com/documentation/sdk-cpp/dev_guide/topics/create-olp-client-settings.html) section in the Developer Guide.
35
+
You can use the `AuthenticationSettings` object to create the `OlpClientSettings` object. For more information, see the [related section](https://developer.here.com/documentation/sdk-cpp/dev_guide/topics/create-olp-client-settings.html) in the Developer Guide.
34
36
35
37
## Authenticate using project authentication
36
38
37
-
1.Create your application and get your API key.
39
+
1.Get your platform credentials.
38
40
39
-
For instructions, see the [Manage Apps](https://developer.here.com/documentation/access-control/user_guide/topics/manage-apps.html) section in the Terms and Permissions User Guide.
41
+
For instructions, see the [Register Your Application](https://developer.here.com/documentation/identity-access-management/dev_guide/topics/plat-token.html#step-1-register-your-application) section in the Identity & Access Management Developer Guide.
40
42
41
-
2. Create a function that returns your API key.
42
-
3. Set up the `AuthenticationSettings` object with your function that returns the API key.
43
+
2. Initialize the `AuthenticationCredentials` class using the **here.access.key.іd** and **here.access.key.secret** from the `credentials.properties` file as `kKeyId` and `kKeySecret` respectively.
43
44
44
-
> Note: Do not trigger any tasks on `TaskScheduler` as this might result in a deadlock.
45
+
> Note: You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://developer.here.com/documentation/sdk-cpp/api_reference/classolp_1_1authentication_1_1_authentication_credentials.html#a6bfd8347ebe89e45713b966e621dccdd).
You can use the `AuthenticationSettings` object to create the `OlpClientSettings` object. For more information, see the [related](https://developer.here.com/documentation/sdk-cpp/dev_guide/topics/create-olp-client-settings.html) section in the Developer Guide.
77
+
You can use the `AuthenticationSettings` object to create the `OlpClientSettings` object. For more information, see the [related section](https://developer.here.com/documentation/sdk-cpp/dev_guide/topics/create-olp-client-settings.html) in the Developer Guide.
55
78
56
79
## Authenticate using federated credentials
57
80
58
81
1. Get your platform credentials.
59
82
60
-
For instructions, see the [Get Credentials](https://developer.here.com/olp/documentation/access-control/user-guide/topics/get-credentials.html) section in the Terms and Permissions User Guide.
83
+
For instructions, see the [Register Your Application](https://developer.here.com/documentation/identity-access-management/dev_guide/topics/plat-token.html#step-1-register-your-application) section in the Identity & Access Management Developer Guide.
61
84
62
85
You get the `credentials.properties` file.
63
86
64
87
2. Initialize the `AuthenticationCredentials` class using the **here.access.key.іd** and **here.access.key.secret** from the `credentials.properties` file as `kKeyId` and `kKeySecret` respectively.
65
88
66
-
> Note: You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://developer.here.com/documentation/sdk-cpp/api_reference/classolp_1_1authentication_1_1AuthenticationCredentials.html#a6bfd8347ebe89e45713b966e621dccdd).
89
+
> Note: You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://developer.here.com/documentation/sdk-cpp/api_reference/classolp_1_1authentication_1_1_authentication_credentials.html#a6bfd8347ebe89e45713b966e621dccdd).
@@ -80,7 +103,7 @@ You can use the `AuthenticationSettings` object to create the `OlpClientSettings
80
103
81
104
4. Get your federated (Facebook or ArcGIS) properties.
82
105
83
-
You should have at least your federated access token. For the complete list of federated properties, see the [related](https://developer.here.com/documentation/sdk-cpp/api_reference/structolp_1_1authentication_1_1AuthenticationClient_1_1FederatedProperties.html) documentation.
106
+
You should have at least your federated access token. For the complete list of federated properties, see the [related documentation](https://developer.here.com/documentation/sdk-cpp/api_reference/structolp_1_1authentication_1_1_authentication_client_1_1_federated_properties.html).
84
107
85
108
5. Initialize your federated properties.
86
109
@@ -91,7 +114,7 @@ You can use the `AuthenticationSettings` object to create the `OlpClientSettings
91
114
92
115
6. Create the `SignInUserCallback` class.
93
116
94
-
For more information, see the [`AuthenticationClient` reference documentation](https://developer.here.com/documentation/sdk-cpp/api_reference/classolp_1_1authentication_1_1AuthenticationClient.html)
117
+
For more information, see the [`AuthenticationClient` reference documentation](https://developer.here.com/documentation/sdk-cpp/api_reference/classolp_1_1authentication_1_1_authentication_client.html).
95
118
96
119
7. Create your own token provider using the authentication client created in step 3, your federated credentials, and the `SignInUserCallback` class.
97
120
@@ -118,4 +141,4 @@ You can use the `AuthenticationSettings` object to create the `OlpClientSettings
118
141
119
142
You get an access token. By default, it expires in 24 hours. To continue working with the HERE platform after your token expires, generate a new access token.
120
143
121
-
You can use the `AuthenticationSettings` object to create the `OlpClientSettings` object.
144
+
You can use the `AuthenticationSettings` object to create the `OlpClientSettings` object. For more information, see the [related section](https://developer.here.com/documentation/sdk-cpp/dev_guide/topics/create-olp-client-settings.html) in the Developer Guide.
Copy file name to clipboardExpand all lines: docs/dataservice-cache-example.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,8 @@ On this page, find instructions on how to build and run the example project, get
5
5
Before you run the example project, authorize to the HERE platform:
6
6
7
7
1. On the [Apps & keys](https://platform.here.com/admin/apps) page, copy your application access key ID and access key secret.
8
-
For instructions on how to get the access key ID and access key secret, see the [Get Credentials](https://developer.here.com/olp/documentation/access-control/user-guide/topics/get-credentials.html) section in the Terms and Permissions User Guide.
8
+
9
+
For instructions on how to get the access key ID and access key secret, see the [Register Your Application](https://developer.here.com/documentation/identity-access-management/dev_guide/topics/plat-token.html#step-1-register-your-application) section in the Identity & Access Management Developer Guide.
9
10
10
11
2. In `examples/main.cpp`, replace the placeholders with your access key ID, access key secret, and Here Resource Name (HRN) of the catalog.
11
12
**Note:** You can also specify these values using the command line options.
@@ -65,7 +66,7 @@ To authenticate with the HERE platform, you must get platform credentials that c
65
66
66
67
1. Get your platform credentials.
67
68
68
-
For instructions, see the [Get Credentials](https://developer.here.com/olp/documentation/access-control/user-guide/topics/get-credentials.html) section in the Terms and Permissions User Guide.
69
+
For instructions, see the [Register Your Application](https://developer.here.com/documentation/identity-access-management/dev_guide/topics/plat-token.html#step-1-register-your-application) section in the Identity & Access Management Developer Guide.
Copy file name to clipboardExpand all lines: docs/dataservice-read-catalog-example.md
+9-5Lines changed: 9 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,8 @@ On this page, find instructions on how to build and run the example project on d
5
5
Before you run the example project, authorize to the HERE platform:
6
6
7
7
1. On the [Apps & keys](https://platform.here.com/admin/apps) page, copy your application access key ID and access key secret.
8
-
For instructions on how to get the access key ID and access key secret, see the [Get Credentials](https://developer.here.com/olp/documentation/access-control/user-guide/topics/get-credentials.html) section in the Terms and Permissions User Guide.
8
+
9
+
For instructions on how to get the access key ID and access key secret, see the [Register Your Application](https://developer.here.com/documentation/identity-access-management/dev_guide/topics/plat-token.html#step-1-register-your-application) section in the Identity & Access Management Developer Guide.
9
10
10
11
2. In `examples/main.cpp`, replace the placeholders with your access key ID, access key secret, and Here Resource Name (HRN) of the catalog.
11
12
**Note:** You can also specify these values using the command line options.
@@ -68,8 +69,9 @@ To integrate the HERE Data SDK for C++ libraries in the Android example project:
68
69
Before you integrate the HERE Data SDK for C++ libraries in the Android example project:
69
70
70
71
1. Set up the Android environment.
71
-
2. In `examples/android/app/src/main/cpp/MainActivityNative.cpp.in`, replace the placeholders with your application access key ID, access key secret, and catalog HRN and specify that the example should run `RunExampleRead`.
72
-
For instructions on how to get the access key ID and access key secret, see the [Get Credentials](https://developer.here.com/olp/documentation/access-control/user-guide/topics/get-credentials.html) section in the Terms and Permissions User Guide.
72
+
2. In `examples/android/app/src/main/cpp/MainActivityNative.cpp.in`, replace the placeholders with your application access key ID, access key secret, and catalog HRN and specify that the example should run `RunExampleRead`.
73
+
74
+
For instructions on how to get the access key ID and access key secret, see the [Register Your Application](https://developer.here.com/documentation/identity-access-management/dev_guide/topics/plat-token.html#step-1-register-your-application) section in the Identity & Access Management Developer Guide.
73
75
74
76
### <aname="build-sdk-android"></a>Build the HERE Data SDK for C++
75
77
@@ -119,9 +121,11 @@ Before you integrate the HERE Data SDK for C++ libraries in the iOS example proj
119
121
120
122
1. To set up the iOS development environment, install the `XCode` and command-line tools.
121
123
2. Install external dependencies.
124
+
122
125
For information on dependencies and installation instructions, see the [related section](https://github.com/heremaps/here-data-sdk-cpp#dependencies) in the README.md file.
123
126
3. In `examples/ios/ViewController.mm`, replace the placeholders with your application access key ID, access key secret, and catalog HRN and specify that the example should run `RunExampleRead`.
124
-
For instructions on how to get the access key ID and access key secret, see the [Get Credentials](https://developer.here.com/olp/documentation/access-control/user-guide/topics/get-credentials.html) section in the Terms and Permissions User Guide.
127
+
128
+
For instructions on how to get the access key ID and access key secret, see the [Register Your Application](https://developer.here.com/documentation/identity-access-management/dev_guide/topics/plat-token.html#step-1-register-your-application) section in the Identity & Access Management Developer Guide.
125
129
126
130
### <aname="build-sdk-ios"></a>Build the HERE Data SDK for C++
127
131
@@ -169,7 +173,7 @@ To authenticate with the HERE platform, you must get platform credentials that c
169
173
170
174
1. Get your platform credentials.
171
175
172
-
For instructions, see the [Get Credentials](https://developer.here.com/olp/documentation/access-control/user-guide/topics/get-credentials.html) section in the Terms and Permissions User Guide.
176
+
For instructions, see the [Register Your Application](https://developer.here.com/documentation/identity-access-management/dev_guide/topics/plat-token.html#step-1-register-your-application) section in the Identity & Access Management Developer Guide.
Copy file name to clipboardExpand all lines: docs/dataservice-read-from-stream-layer-example.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,8 @@ On this page, you can find instructions on how to build and run the example proj
5
5
Before you run the example project, authorize to the HERE platform:
6
6
7
7
1. On the [Apps & keys](https://platform.here.com/admin/apps) page, copy your application access key ID and access key secret.
8
-
For instructions on how to get the access key ID and access key secret, see the [Get Credentials](https://developer.here.com/olp/documentation/access-control/user-guide/topics/get-credentials.html) section in the Terms and Permissions User Guide.
8
+
9
+
For instructions on how to get the access key ID and access key secret, see the [Register Your Application](https://developer.here.com/documentation/identity-access-management/dev_guide/topics/plat-token.html#step-1-register-your-application) section in the Identity & Access Management Developer Guide.
9
10
10
11
2. In `examples/main.cpp`, replace the placeholders with your access key ID, access key secret, and Here Resource Name (HRN) of the catalog.
11
12
**Note:** You can also specify these values using the command line options.
@@ -65,7 +66,7 @@ To authenticate with the HERE platform, you must get platform credentials that c
65
66
66
67
1. Get your platform credentials.
67
68
68
-
For instructions, see the [Get Credentials](https://developer.here.com/olp/documentation/access-control/user-guide/topics/get-credentials.html) section in the Terms and Permissions User Guide.
69
+
For instructions, see the [Register Your Application](https://developer.here.com/documentation/identity-access-management/dev_guide/topics/plat-token.html#step-1-register-your-application) section in the Identity & Access Management Developer Guide.
0 commit comments