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
- Migrated dev guide to have it here on GitHub
- Updated existing docs to point to the new guide
- Updated links to HERE docs portal
Relates-To: DATASDK-92, DATASDK-99
Signed-off-by: Andrey Kashcheev <ext-andrey.kashcheev@here.com>
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ HERE Data SDK for C++ is a C++ client for the <a href="https://platform.here.com
4
4
5
5
## Use the SDK
6
6
7
-
To learn how to install and use the Data SDK, see the <ahref="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/get-started.md"target="_blank">Getting Started Guide</a> and <ahref="https://www.here.com/docs/bundle/data-sdk-for-cpp-developer-guide/page/README.html"target="blank">Developer Guide</a>.
7
+
To learn how to install and use the Data SDK, see the <ahref="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/get-started.md"target="_blank">Getting Started Guide</a> and <ahref="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/dev_guide/SUMMARY.md"target="blank">Developer Guide</a>.
8
8
9
9
## Health check
10
10
@@ -30,13 +30,13 @@ To learn how to install and use the Data SDK, see the <a href="https://github.co
30
30
31
31
We try to develop and maintain our API in a way that preserves its compatibility with the existing applications. Changes in Data SDK for C++ are greatly influenced by the Data API development. Data API introduces breaking changes 6 months in advance. Therefore, you may need to migrate to a new version of Data SDK for C++ every half a year.
32
32
33
-
For more information on Data API, see its <ahref="https://www.here.com/docs/bundle/data-api-developer-guide/page/README.html"target="_blank">Developer Guide</a> and <ahref="https://www.here.com/docs/category/data-api"target="_blank">API Reference</a>.
33
+
For more information on Data API, see its <ahref="https://docs.here.com/data-api/docs/data-api-intro"target="_blank">Developer Guide</a> and <ahref="https://docs.here.com/data-api/reference"target="_blank">API Reference</a>.
34
34
35
35
When new API is introduced in Data SDK for C++, the old one is not deleted straight away. The standard API deprecation time is 6 months. It gives you time to switch to new code. However, we do not provide ABI backward compatibility.
36
36
37
-
Learn more about deprecated methods, functions, and parameters in the Data SDK for C++ <ahref="https://www.here.com/docs/bundle/data-sdk-for-cpp-api-reference/page/index.html"target="_blank">API Reference</a> and <ahref="https://github.com/heremaps/here-data-sdk-cpp/blob/master/CHANGELOG.md"target="_blank">changelog</a>.
37
+
Learn more about deprecated methods, functions, and parameters in the Data SDK for C++ <ahref="https://heremaps.github.io/here-data-sdk-cpp/index.html"target="_blank">API Reference</a> and <ahref="https://github.com/heremaps/here-data-sdk-cpp/blob/master/CHANGELOG.md"target="_blank">changelog</a>.
38
38
39
-
For more information on Data SDK for C++, see our <ahref="https://www.here.com/docs/bundle/data-sdk-for-cpp-developer-guide/page/README.html"target="blank">Developer Guide</a>.
39
+
For more information on Data SDK for C++, see our <ahref="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/dev_guide/SUMMARY.md"target="blank">Developer Guide</a>.
Copy file name to clipboardExpand all lines: docs/OverallArchitecture.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
## Outline
4
4
5
-
This document describes the overall architecture of HERE Data SDK for C++ (here also referred to as SDK). For an overview of the scope and the features of the SDK, see [README.md](../README.md#why-use).
5
+
This document describes the overall architecture of HERE Data SDK for C++ (here also referred to as SDK). For an overview of the scope and the features of the SDK, see [README.md](../README.md#use-the-sdk).
6
6
7
7
## Component overview
8
8
@@ -56,7 +56,7 @@ The dataservice-read module wraps a subset of the Data REST API related to readi
Copy file name to clipboardExpand all lines: docs/authenticate.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
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
4
5
-
For instructions, see the [OAuth tokens](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/dev-token.html) section in the Identity & Access Management Developer Guide.
5
+
For instructions, see the [OAuth tokens](https://docs.here.com/identity-and-access-management/docs/manage-api-oauth) section in the Identity & Access Management Developer Guide.
6
6
7
7
> #### Note
8
8
> 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.
@@ -11,14 +11,14 @@ For instructions, see the [OAuth tokens](https://www.here.com/docs/bundle/identi
11
11
12
12
1. Get your platform credentials.
13
13
14
-
For instructions, see the [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
14
+
For instructions, see the [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.
15
15
16
16
You get the `credentials.properties` file.
17
17
18
18
2. Initialize the authentication settings using the **here.access.key.іd** and **here.access.key.secret** from the `credentials.properties` file as `kKeyId` and `kKeySecret` respectively.
19
19
20
20
> #### Note
21
-
> You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://www.here.com/docs/bundle/data-sdk-for-cpp-api-reference/page/namespaceolp_1_1authentication.html#).
21
+
> You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://heremaps.github.io/here-data-sdk-cpp/namespaceolp_1_1authentication.html).
@@ -42,12 +42,12 @@ You can use the `AuthenticationSettings` object to create the `OlpClientSettings
42
42
43
43
1. Get your platform credentials.
44
44
45
-
For instructions, see the [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
45
+
For instructions, see the [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.
46
46
47
47
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.
48
48
49
49
> #### Note
50
-
> You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://www.here.com/docs/bundle/data-sdk-for-cpp-api-reference/page/namespaceolp_1_1authentication.html#).
50
+
> You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://heremaps.github.io/here-data-sdk-cpp/namespaceolp_1_1authentication.html).
@@ -88,14 +88,14 @@ You can use the `AuthenticationSettings` object to create the `OlpClientSettings
88
88
89
89
1. Get your platform credentials.
90
90
91
-
For instructions, see the [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
91
+
For instructions, see the [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.
92
92
93
93
You get the `credentials.properties` file.
94
94
95
95
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.
96
96
97
97
> #### Note
98
-
> You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://www.here.com/docs/bundle/data-sdk-for-cpp-api-reference/page/namespaceolp_1_1authentication.html#).
98
+
> You can also retrieve your credentials from the `credentials.properties` file using the `ReadFromFile` method. For more information, see the [related API documentation](https://heremaps.github.io/here-data-sdk-cpp/namespaceolp_1_1authentication.html).
@@ -111,7 +111,7 @@ You can use the `AuthenticationSettings` object to create the `OlpClientSettings
111
111
112
112
4. Get your federated (Facebook or ArcGIS) properties.
113
113
114
-
You should have at least your federated access token. For the complete list of federated properties, see the [related documentation](https://www.here.com/docs/bundle/data-sdk-for-cpp-api-reference/page/structolp_1_1authentication_1_1AuthenticationClient_1_1FederatedProperties.html).
114
+
You should have at least your federated access token. For the complete list of federated properties, see the [related documentation](https://heremaps.github.io/here-data-sdk-cpp/structolp_1_1authentication_1_1AuthenticationClient_1_1FederatedProperties.html).
To learn how to get or change cache size, see [Work with a cache](https://www.here.com/docs/bundle/data-sdk-for-cpp-developer-guide/page/topics/work-with-cache.html).
70
+
To learn how to get or change cache size, see [Work with a cache](./dev_guide/topics/work-with-cache.md).
71
71
72
72
6. Set up the `OlpClientSettings` object, and if you want to add the expiration limit for the data that is stored in the cache, set the `default_cache_expiration` to the needed expiration time.
Copy file name to clipboardExpand all lines: docs/dataservice-cache-example.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ On this page, find instructions on how to build and run the cache example projec
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
8
9
-
For instructions on how to get the access key ID and access key secret, see the [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
9
+
For instructions on how to get the access key ID and access key secret, see the [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.
10
10
11
11
2. In <ahref="https://github.com/heremaps/here-data-sdk-cpp/blob/master/examples/main.cpp"target="_blank">`examples/main.cpp`</a>, replace the placeholders with your access key ID, access key secret, and Here Resource Name (HRN) of the catalog.
12
12
@@ -64,9 +64,9 @@ After building and running the example project, you see the following informatio
64
64
65
65
## How it works
66
66
67
-
### <aname="get-partition-data-mutable"></a>Get data from a versioned layer with a cache
67
+
### Get data from a versioned layer with a cache
68
68
69
-
You can get data from a [versioned layer](https://www.here.com/docs/bundle/data-api-developer-guide/page/rest/layers.html#versioned-layers) with a mutable or protected cache.
69
+
You can get data from a [versioned layer](https://docs.here.com/data-api/docs/layers#versioned-layers) with a mutable or protected cache.
70
70
71
71
**To get data from the versioned layer with mutable cache:**
Copy file name to clipboardExpand all lines: docs/dataservice-read-catalog-example.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ On this page, find instructions on how to build and run the read example project
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
8
9
-
For instructions on how to get the access key ID and access key secret, see [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
9
+
For instructions on how to get the access key ID and access key secret, see [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.
10
10
11
11
2. In <ahref="https://github.com/heremaps/here-data-sdk-cpp/blob/master/examples/main.cpp"target="_blank">`examples/main.cpp`</a>, replace the placeholders with your access key ID, access key secret, and Here Resource Name (HRN) of the catalog.
12
12
@@ -74,7 +74,7 @@ To integrate the Data SDK libraries in the Android example project:
74
74
2. In <ahref="https://github.com/heremaps/here-data-sdk-cpp/blob/master/examples/android/app/src/main/cpp/MainActivityNative.cpp.in"target="_blank">`examples/android/app/src/main/cpp/MainActivityNative.cpp.in`</a>, replace the placeholders with your application access key ID, access key secret, and catalog HRN and specify that the example should run `RunExampleRead`.
75
75
76
76
> #### Note
77
-
> To learn how to get the access key ID and access key secret, see the [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
77
+
> To learn how to get the access key ID and access key secret, see the [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.
78
78
79
79
### Build the Data SDK on Android
80
80
@@ -124,7 +124,7 @@ To integrate the Data SDK libraries in the iOS example project written in the Ob
124
124
3. In <ahref="https://github.com/heremaps/here-data-sdk-cpp/blob/master/examples/ios/ViewController.mm"target="_blank">`examples/ios/ViewController.mm`</a>, replace the placeholders with your application access key ID, access key secret, and catalog HRN and specify that the example should run `RunExampleRead`.
125
125
126
126
> #### Note
127
-
> To learn how to get the access key ID and access key secret, see the [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
127
+
> To learn how to get the access key ID and access key secret, see the [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.
Copy file name to clipboardExpand all lines: docs/dataservice-read-from-stream-layer-example.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ On this page, you can find instructions on how to build and run the cache exampl
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
8
9
-
For instructions on how to get the access key ID and access key secret, see the [Register your application](https://www.here.com/docs/bundle/identity-and-access-management-developer-guide/page/topics/plat-token.html#step-1-register-your-application-and-get-credentials) section in the Identity & Access Management Developer Guide.
9
+
For instructions on how to get the access key ID and access key secret, see the [Register your application](https://docs.here.com/identity-and-access-management/docs/plat-using-oidc#step-2---register-your-app-and-get-credentials) section in the Identity & Access Management Developer Guide.
10
10
11
11
2. In <ahref="https://github.com/heremaps/here-data-sdk-cpp/blob/master/examples/main.cpp"target="_blank">examples/main.cpp</a>, replace the placeholders with your access key ID, access key secret, and Here Resource Name (HRN) of the catalog.
12
12
@@ -62,7 +62,7 @@ After building and running the example project, you see the following informatio
62
62
63
63
### Get data from a stream layer
64
64
65
-
You can read messages from a [stream layer](https://www.here.com/docs/bundle/data-api-developer-guide/page/rest/layers.html#stream-layers) if you subscribe to it.
65
+
You can read messages from a [stream layer](https://docs.here.com/data-api/docs/creating-stream-layer) if you subscribe to it.
0 commit comments