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: documentation/step-by-step.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,13 +10,13 @@ Breinify's DigitalDNA API puts dynamic behavior-based, people-driven data right
10
10
11
11
#### What is Breinify's DigitialDNA
12
12
13
-
Breinify's DigitalDNA API puts dynamic behavior-based, people-driven data right at your fingertips. Did you ever asked yourself why it is so difficult to provide great user experience to your visitors? With all this data out there in the world wide web, it should be so easy to provide a unique experience to every visitor.
13
+
Breinify's DigitalDNA API puts dynamic behavior-based, people-driven data right at your fingertips. We believe that in many situations, a critical component of a great user experience is personalization. With all the data available on the web it should be easy to provide a unique experience to every visitor, and yet, sometimes you may find yourself wondering why it is so difficult.
14
14
15
15
Thanks to **Breinify's DigitalDNA** you are now able to adapt your online presence to your visitors needs and **provide a unique experience**. Let's walk step-by-step through a simple example.
16
16
17
-
#### 1. Step: Download the library
17
+
#### Step 1: Download the library
18
18
19
-
As with every JavaScript library, the first things you have to do, is to load the library (or integerate it into your project).
19
+
As with every JavaScript library, the first thing you have to do is to load the library (or integerate it into your project).
or just download the version from [GitHub](https://raw.githubusercontent.com/Breinify/brein-api-library-javascript-browser/master/dist/breinify-api.min.js) directly.
There are several different ways on how to use the downloaded file(s). The easiest way is to use the minified version *breinify-api.min.js*. The library is concatenated and contains all the dependencies needed. Thus, the library does not need any additional files and can be directly loaded (same applies for the unminified version [breinify-api.js](https://raw.githubusercontent.com/Breinify/brein-api-library-javascript-browser/master/dist/breinify-api.js)).
45
+
There are several different to use the downloaded library file(s). The easiest way is to use the minified version *breinify-api.min.js*. The library is concatenated and contains all the dependencies needed. Thus, the library does not need any additional files and can be directly loaded (same applies for the unminified version [breinify-api.js](https://raw.githubusercontent.com/Breinify/brein-api-library-javascript-browser/master/dist/breinify-api.js)).
46
46
47
47
The file is integrated within a web-site by adding the needed script-tag, pointing to the location of the downloaded file (e.g., *js/breinify-api.min.js*):
48
48
@@ -58,9 +58,9 @@ It is also possible to omit the download and just point to the library file prov
58
58
59
59
**Note:** The library can also be loaded asynchroniously using the *async* and *onload* attribute (officially introduced in HTML5). In that case, the configuration of the library and all bindings should be performed after the library is loaded (i.e., within the *onload* function).
60
60
61
-
#### 3. Step: Configure the library
61
+
#### Step 3: Configure the library
62
62
63
-
The library can be configured easily within a script-block, which should be placed after the loading of the library, but prior to any other usage. This ensures, that the library will be ready for usage, whenever a*activity* or *lookup* is triggered. The most important and only mandatory value to configure is the API-key used to communicate with the engine. To retrieve a **free API-key** you have to sign up under[https://www.breinify.com](https://www.breinify.com).
63
+
The library can be configured easily within a script-block, which should be placed after the loading of the library, but prior to any other usage. This ensures that the library will be ready for usage whenever an*activity* or *lookup* is triggered. The only mandatory configuration value is the API-key used to communicate with the engine. To retrieve a **free API-key** you may sign up at[https://www.breinify.com](https://www.breinify.com).
64
64
65
65
```html
66
66
<script>
@@ -71,13 +71,13 @@ The library can be configured easily within a script-block, which should be plac
71
71
**Note:**
72
72
A full list of the configuration parameters can be found [here](./api.md).
73
73
74
-
#### 4. Step: Start using the library
74
+
#### Step 4: Start using the library
75
75
76
76
##### Placing activity triggers
77
77
78
-
The engine powering the DigitalDNA API provides two endpoints. The first endpoint is used to inform the engine about the activities performed by visitors of your site. The activities are used to understand the user's current interest and infer the intent. It becomes more and more accurate across different users and verticals, the more activities are collected. It should be noted, that any personal information is not stored within the engine, thus each individuals privacy is safe. The engine understands several different activities performed by a user, e.g., landing, login, search, item selection, or logout.
78
+
The engine powering the DigitalDNA API provides two endpoints. The first endpoint is used to inform the engine about the activities performed by visitors of your site. The activities are used to understand the user's current interest and infer the intent. It becomes more and more accurate across different users and verticals as more activities are collected. It should be noted, that any personal information is not stored within the engine, thus each individual's privacy is well protected. The engine understands several different activities performed by a user, e.g., landing, login, search, item selection, or logout.
79
79
80
-
The engine is informed by an activity by executing *Breinify.activity(...)*. If you want to trigger an activity, you normally observe events like page-loaded or click.
80
+
The engine is informed of an activity by executing *Breinify.activity(...)*. If you want to trigger an activity, you normally observe events like page-loaded or click.
81
81
82
82
```html
83
83
<script>
@@ -95,7 +95,7 @@ The engine is informed by an activity by executing *Breinify.activity(...)*. If
95
95
</script>
96
96
```
97
97
98
-
The example above, observes a click event on all elements with the *product* class. If such an element is clicked, the library is utilized to read a specific value from a session-cookie, which contains the current user's email. If such a cookie exists, the name of the product is read from the DOM-tree and send to the engine, adding the additional information *selectProduct* (to define the type of the activity), and the category (e.g., *services*).
98
+
The example above observes a click event on all elements with the *product* class. If such an element is clicked, the library is utilized to read a specific value from a session-cookie, which contains the current user's email. If such a cookie exists, the name of the product is read from the DOM-tree and send to the engine, adding the additional information *selectProduct* (to define the type of the activity), and the category (e.g., *services*).
99
99
100
100
**Note:**
101
101
A full list of the available utility functions (*Breinify.UTL*) and there purpose and parameters, can be found [here](./api.md).
@@ -124,4 +124,4 @@ Look-ups are used, e.g., to change the appearance of the site, increase the qual
124
124
```
125
125
126
126
**Note:**
127
-
The JSON structure of the reply of the *lookup* is documented in the [API library documentation](./api.md).
127
+
The JSON structure of the *lookup* response is documented in the [API library documentation](./api.md).
0 commit comments