Skip to content

Commit

Permalink
TECHDOCS-4675 (#1520)
Browse files Browse the repository at this point in the history 
Update developer.here.com links to here.com/docs.

Resolves: TECHDOCS-4675

Signed-off-by: Tom Papiernik <[email protected]>
  • Loading branch information
@tomekpapiernik
tomekpapiernik committed Jun 11, 2024
1 parent b9582fd commit ff510e8
Show file tree
Hide file tree
Showing 9 changed files with 42 additions and 42 deletions.
8 changes: 4 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ HERE Data SDK for C++ is a C++ client for the <a href="https://platform.here.com

## Use the SDK

To learn how to install and use the Data SDK, see the <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/GettingStartedGuide.md" target="_blank">Getting Started Guide</a> and <a href="https://developer.here.com/documentation/sdk-cpp/dev_guide/index.html" target="blank">Developer Guide</a>.
To learn how to install and use the Data SDK, see the <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/docs/GettingStartedGuide.md" target="_blank">Getting Started Guide</a> and <a href="https://www.here.com/docs/bundle/data-sdk-for-cpp-developer-guide/page/README.html" target="blank">Developer Guide</a>.

## Health check

Expand Down Expand Up @@ -38,13 +38,13 @@ To learn how to install and use the Data SDK, see the <a href="https://github.co

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.

For more information on Data API, see its <a href="https://developer.here.com/documentation/data-api/data_dev_guide/index.html" target="_blank">Developer Guide</a> and <a href="https://developer.here.com/documentation/data-api/api-reference.html" target="_blank">API Reference</a>.
For more information on Data API, see its <a href="https://www.here.com/docs/bundle/data-api-developer-guide/page/README.html" target="_blank">Developer Guide</a> and <a href="https://www.here.com/docs/category/data-api" target="_blank">API Reference</a>.

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.

Learn more about deprecated methods, functions, and parameters in the Data SDK for C++ <a href="https://developer.here.com/documentation/sdk-cpp/api_reference/index.html" target="_blank">API Reference</a> and <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/CHANGELOG.md" target="_blank">changelog</a>.
Learn more about deprecated methods, functions, and parameters in the Data SDK for C++ <a href="https://www.here.com/docs/bundle/data-sdk-for-cpp-api-reference/page/index.html" target="_blank">API Reference</a> and <a href="https://github.com/heremaps/here-data-sdk-cpp/blob/master/CHANGELOG.md" target="_blank">changelog</a>.

For more information on Data SDK for C++, see our <a href="https://developer.here.com/documentation/sdk-cpp/dev_guide/index.html" target="blank">Developer Guide</a>.
For more information on Data SDK for C++, see our <a href="https://www.here.com/docs/bundle/data-sdk-for-cpp-developer-guide/page/README.html" target="blank">Developer Guide</a>.

## Supported platforms

Expand Down
42 changes: 21 additions & 21 deletions docs/OverallArchitecture.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,21 +48,21 @@ For more information on how to use this module, see the [read and write examples
The dataservice-read module wraps a subset of the Data REST API related to reading data from platform catalogs. It allows reading of data from the following layer types and with the listed Data APIs:

* Versioned layer. Used Data APIs:
* [Config API](https://developer.here.com/documentation/data-store/api-reference-config.html)
* [Metadata API](https://developer.here.com/documentation/data-store/api-reference-metadata.html)
* [Query API](https://developer.here.com/documentation/data-store/api-reference-query.html)
* [Blob API](https://developer.here.com/documentation/data-store/api-reference-blob.html)
* [Config API](https://www.here.com/docs/bundle/data-api-config-v1-api-reference/page/index.html)
* [Metadata API](https://www.here.com/docs/bundle/data-api-metadata-v1-api-reference/page/index.html)
* [Query API](https://www.here.com/docs/bundle/data-api-query-v1-api-reference/page/index.html)
* [Blob API](https://www.here.com/docs/bundle/data-api-blob-v1-api-reference/page/index.html)
* Volatile layer. Used Data APIs:
* [Config API](https://developer.here.com/documentation/data-store/api-reference-config.html)
* [Metadata API](https://developer.here.com/documentation/data-store/api-reference-metadata.html)
* [Query API](https://developer.here.com/documentation/data-store/api-reference-query.html)
* [Volatile API](https://developer.here.com/documentation/data-store/api-reference-volatile-blob.html)
* [Config API](https://www.here.com/docs/bundle/data-api-config-v1-api-reference/page/index.html)
* [Metadata API](https://www.here.com/docs/bundle/data-api-metadata-v1-api-reference/page/index.html)
* [Query API](https://www.here.com/docs/bundle/data-api-query-v1-api-reference/page/index.html)
* [Volatile API](https://www.here.com/docs/bundle/data-api-volatile-blob-v1-api-reference/page/index.html)
* Index layer (not supported yet). Used Data APIs:
* [Index API](https://developer.here.com/documentation/data-store/api-reference-index.html)
* [Blob API](https://developer.here.com/documentation/data-store/api-reference-blob.html)
* [Index API](https://www.here.com/docs/bundle/data-api-index-v1-api-reference/page/index.html)
* [Blob API](https://www.here.com/docs/bundle/data-api-blob-v1-api-reference/page/index.html)
* Stream layer. Used Data APIs:
* [Stream API](https://developer.here.com/documentation/data-store/api-reference-stream.html)
* [Blob API](https://developer.here.com/documentation/data-store/api-reference-blob.html)
* [Stream API](https://www.here.com/docs/bundle/data-api-stream-v1-api-reference/page/index.html)
* [Blob API](https://www.here.com/docs/bundle/data-api-blob-v1-api-reference/page/index.html)

For more information on how to use this module, see the [read example](dataservice-read-catalog-example.md).

Expand All @@ -71,18 +71,18 @@ For more information on how to use this module, see the [read example](dataservi
The dataservice-write module wraps a subset of the Data REST API related to writing data to platform catalogs. It allows writing of data to the following layer types and with the listed Data APIs:

* Versioned layer. Used Data APIs:
* [Publish API](https://developer.here.com/documentation/data-store/api-reference-publish.html)
* [Blob API](https://developer.here.com/documentation/data-store/api-reference-blob.html)
* [Publish API](https://www.here.com/docs/bundle/data-api-publish-v2-api-reference/page/index.html)
* [Blob API](https://www.here.com/docs/bundle/data-api-blob-v1-api-reference/page/index.html)
* Volatile layer. Used Data APIs:
* [Publish API](https://developer.here.com/documentation/data-store/api-reference-publish.html)
* [Volatile API](https://developer.here.com/documentation/data-store/api-reference-volatile-blob.html)
* [Publish API](https://www.here.com/docs/bundle/data-api-publish-v2-api-reference/page/index.html)
* [Volatile API](https://www.here.com/docs/bundle/data-api-volatile-blob-v1-api-reference/page/index.html)
* Index layer. Used Data APIs:
* [Index API](https://developer.here.com/documentation/data-store/api-reference-index.html)
* [Blob API](https://developer.here.com/documentation/data-store/api-reference-blob.html)
* [Index API](https://www.here.com/docs/bundle/data-api-index-v1-api-reference/page/index.html)
* [Blob API](https://www.here.com/docs/bundle/data-api-blob-v1-api-reference/page/index.html)
* Stream layer. Used Data APIs:
* [Ingest API](https://developer.here.com/documentation/data-store/api-reference-ingest.html)
* [Publish API](https://developer.here.com/documentation/data-store/api-reference-publish.html)
* [Blob API](https://developer.here.com/documentation/data-store/api-reference-blob.html)
* [Ingest API](https://here.com/docs/bundle/data-api-ingest-v1-api-reference/page/index.html)
* [Publish API](https://www.here.com/docs/bundle/data-api-publish-v2-api-reference/page/index.html)
* [Blob API](https://www.here.com/docs/bundle/data-api-blob-v1-api-reference/page/index.html)

For more information on how to use this module, see the [write example](dataservice-write-example.md).

Expand Down
16 changes: 8 additions & 8 deletions docs/authenticate.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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).

For instructions, see the [OAuth tokens](https://developer.here.com/documentation/identity-access-management/dev_guide/topics/dev-token.html) section in the Identity & Access Management Developer Guide.
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.

> #### 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.
Expand All @@ -11,14 +11,14 @@ For instructions, see the [OAuth tokens](https://developer.here.com/documentatio

1. Get your platform credentials.

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.
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.

You get the `credentials.properties` file.

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.

> #### 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 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#).
```cpp
olp::authentication::Settings settings({kKeyId, kKeySecret});
Expand All @@ -42,12 +42,12 @@ You can use the `AuthenticationSettings` object to create the `OlpClientSettings

1. Get your platform credentials.

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.
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.

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.

> #### 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 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#).
```cpp
olp::authentication::AuthenticationCredentials credentials(kKeyId, kKeySecret);
Expand Down Expand Up @@ -88,14 +88,14 @@ You can use the `AuthenticationSettings` object to create the `OlpClientSettings
1. Get your platform credentials.
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.
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.
You get the `credentials.properties` file.
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.
> #### 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 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#).
```cpp
olp::authentication::AuthenticationCredentials credentials(kKeyId, kKeySecret);
Expand All @@ -111,7 +111,7 @@ You can use the `AuthenticationSettings` object to create the `OlpClientSettings

4. Get your federated (Facebook or ArcGIS) properties.

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).
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).

5. Initialize your federated properties.

Expand Down
2 changes: 1 addition & 1 deletion docs/create-platform-client-settings.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ You need to create the `OlpClientSettings` object to get catalog and partition m
olp::client::OlpClientSettingsFactory::CreateDefaultCache(cache_settings);
```

To learn how to get or change cache size, see [Work with a cache](https://developer.here.com/documentation/sdk-cpp/dev_guide/docs/work-with-cache.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).

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.

Expand Down
4 changes: 2 additions & 2 deletions docs/dataservice-cache-example.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ On this page, find instructions on how to build and run the cache example projec

1. On the [Apps & keys](https://platform.here.com/admin/apps) page, copy your application access key ID and access key secret.

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.
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.

2. In <a href="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.

Expand Down Expand Up @@ -66,7 +66,7 @@ After building and running the example project, you see the following informatio

### <a name="get-partition-data-mutable"></a>Get data from a versioned layer with a cache

You can get data from a [versioned layer](https://developer.here.com/documentation/data-user-guide/portal/layers/layers.html#versioned-layers) with a mutable or protected cache.
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.

**To get data from the versioned layer with mutable cache:**

Expand Down
2 changes: 1 addition & 1 deletion docs/dataservice-read-catalog-example.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ The `Partition` class contains partition metadata and exposes the following memb

### Get data from a versioned layer

You can request any data version from a [versioned layer](https://developer.here.com/documentation/data-user-guide/portal/layers/layers.html#versioned-layers). When you request a particular version of data from the versioned layer, the partition you receive in the response may have a lower version number than you requested. The version of a layer or partition represents the catalog version in which the layer or partition was last updated.
You can request any data version from a [versioned layer](https://www.here.com/docs/bundle/data-api-developer-guide/page/rest/layers.html#versioned-layers). When you request a particular version of data from the versioned layer, the partition you receive in the response may have a lower version number than you requested. The version of a layer or partition represents the catalog version in which the layer or partition was last updated.

**To get data from the versioned layer:**

Expand Down
4 changes: 2 additions & 2 deletions docs/dataservice-read-from-stream-layer-example.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ On this page, you can find instructions on how to build and run the cache exampl

1. On the [Apps & keys](https://platform.here.com/admin/apps) page, copy your application access key ID and access key secret.

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.
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.

2. In <a href="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.

Expand Down Expand Up @@ -62,7 +62,7 @@ After building and running the example project, you see the following informatio

### Get data from a stream layer

You can read messages from a [stream layer](https://developer.here.com/documentation/data-user-guide/portal/layers/layers.html#stream-layers) if you subscribe to it.
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.

**To get data from the stream layer:**

Expand Down
Loading

0 comments on commit ff510e8

Please sign in to comment.