Skip to content

Commit

Permalink
Feat: document the use of server url
Browse files Browse the repository at this point in the history
  • Loading branch information
SWH-Relewise committed Nov 23, 2023
1 parent 6e6cf39 commit b97bac1
Showing 1 changed file with 23 additions and 7 deletions.
30 changes: 23 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,27 @@ npm install @relewise/client

### Bootstrapping

Whether you need to track or search, you need to start by bootstrapping either the `Tracker` or `Searcher`.
Whether you need to track, search or recommend, you need to start by bootstrapping either the `Tracker`, `Searcher` or `Recommender`.

```ts
const tracker = new Tracker(RELEWISE_DATASET_ID, RELEWISE_API_KEY);
const searcher = new Searcher(RELEWISE_DATASET_ID, RELEWISE_API_KEY);
const tracker = new Tracker(RELEWISE_DATASET_ID, RELEWISE_API_KEY, {
serverUrl: RELEWISE_SERVER_URL,
});

const searcher = new Searcher(RELEWISE_DATASET_ID, RELEWISE_API_KEY, {
serverUrl: RELEWISE_SERVER_URL,
});

const recommeder = new Recommender(RELEWISE_DATASET_ID, RELEWISE_API_KEY, {
serverUrl: RELEWISE_SERVER_URL,
});
```

Replace the `RELEWISE_DATASET_ID` and `RELEWISE_API_KEY` parameters with your dataset & api key found at [My.Relewise](https://my.relewise.com/developer-settings).
Replace the `RELEWISE_DATASET_ID`, `RELEWISE_API_KEY` and `RELEWISE_SERVER_URL` parameters with your dataset & api key found at [My.Relewise](https://my.relewise.com/developer-settings).

After which you have access to various methods depending on the client you've bootstrapped.

***Note: serverUrl is not required and will default to https://api.relewise.com/***
### Tracking

If you need to track e.g. Product-, Category or Content Views, track Cart Updates or Completed Orders in your solution, you need to use the `Tracker`
Expand Down Expand Up @@ -93,7 +103,9 @@ To use our fully-fledged search engine, start by bootstraping the `Searcher`-cla
Here is a basic usage example for selecting product properties, paging, facets and filters.

```ts
const searcher = new Searcher(RELEWISE_DATASET_ID, RELEWISE_API_KEY);
const searcher = new Searcher(RELEWISE_DATASET_ID, RELEWISE_API_KEY, {
serverUrl: RELEWISE_SERVER_URL,
});

const settings = {
language: 'da-DK',
Expand Down Expand Up @@ -132,7 +144,9 @@ You can use the `*` in `dataKeys` to extract properties by conventions - if you
You can also use the `Searcher` for category pages without specifying the `term`:

```ts
const searcher = new Searcher(RELEWISE_DATASET_ID, RELEWISE_API_KEY);
const searcher = new Searcher(RELEWISE_DATASET_ID, RELEWISE_API_KEY, {
serverUrl: RELEWISE_SERVER_URL,
});

const settings = {
language: 'da-DK',
Expand Down Expand Up @@ -174,7 +188,9 @@ When using sorting, it is important to also sort by relevance after sorting by s
You can also batch requests in one HTTP requests to reduce latency.

```ts
const searcher = new Searcher(RELEWISE_DATASET_ID, RELEWISE_API_KEY);
const searcher = new Searcher(RELEWISE_DATASET_ID, RELEWISE_API_KEY, {
serverUrl: RELEWISE_SERVER_URL,
});

const searchCollectionBuilder = new SearchCollectionBuilder(settings)
.addRequest(productSearchBuilder.build())
Expand Down

0 comments on commit b97bac1

Please sign in to comment.