Skip to content

Commit 377030a

Browse files
authored
Update api.md
1 parent f599503 commit 377030a

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

documentation/api.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Breinify's DigitalDNA API puts dynamic behavior-based, people-driven data right
88

99
### API Library Documentation
1010

11-
The library provides several attributes, methods, and objects to simplify the usage of the Breinify API. Besides methods to actually send or retrieve data, it also includes general information (e.g., about the version and used configuration), as well as utilities. Thus, the following documentation is organized in three sections: *General Information*, *API*, and *Utilities (UTL)*.
11+
The library provides several attributes, methods, and objects to simplify the usage of the Breinify API. Besides methods to actually send or retrieve data, it also includes general information (e.g., about the version and used configuration), as well as utilities. Thus, the following documentation is organized in three sections: *General Attributes*, *API*, and *Utilities (UTL)*.
1212

1313
This documentation is organized as following:
1414

@@ -95,7 +95,7 @@ This documentation is organized as following:
9595
<br/>
9696

9797
* **Breinify.setConfig(config)**:<br/>
98-
Contains the current version of the usage library. If an error occurred while loading the library, the version is set to be *'FALLBACK'*.
98+
Updates the current configuration of the library for the properties supplied.
9999

100100
**Parameters**:
101101

@@ -112,7 +112,7 @@ This documentation is organized as following:
112112
#### API
113113

114114
* **Breinify.activity(user, type, category, description, sign, onReady)**:<br/>
115-
Sends an activity to the engine utilizing the API. The call is done asynchronously as POST request. It is important, that a valid API-key is configured prior to using this function.
115+
Sends an activity to the engine utilizing the API. The call is done asynchronously as a POST request. It is important that a valid API-key is configured prior to using this function.
116116

117117
**Parameters**:
118118

@@ -122,11 +122,11 @@ This documentation is organized as following:
122122

123123
{string|null} **category**: The category of the platform/service/products, i.e., one of *apparel*, *home*, *education*, *family*, *food*, *health*, *job*, *services*, or *other*. If not specified, the configured type (see *Breinify.config().category*) is used.
124124

125-
{string|null} **description**: A string with further information about hte activity performed. Depending on the type of the activity, these are typically: the used search query (type === 'search'), the name of the selected product (type === 'selectProduct'), the item added or removed from the cart (type === 'addToCart' || type === 'removeFromCart'), and the amount of items or the value of items with currency (type === 'checkout').
125+
{string|null} **description**: A string with further information about the activity performed. Depending on the type of the activity, some typical descriptions are: the used search query (type === 'search'), the name of the selected product (type === 'selectProduct'), the item added or removed from the cart (type === 'addToCart' || type === 'removeFromCart'), and the amount or monetary value items (type === 'checkout').
126126

127-
{boolean|null} **sign**: A boolean value, specifying if the call should be sign, only available if the *secret* is configured. It is strongly advised, not to use a signed call when utilizing this library.
127+
{boolean|null} **sign**: A boolean value specifying if the call should be signed, which is only available if the *secret* is configured. It is strongly advised not to use a signed call when utilizing this library.
128128

129-
{function|null} **onReady**: A function, which is triggered after the activity was sent to the user. The function has the information sent as first parameter.
129+
{function|null} **onReady**: A function which is triggered after the activity was sent to the user. The function has the information sent as the first parameter.
130130

131131
**Example Usage**:
132132
```javascript
@@ -145,13 +145,13 @@ This documentation is organized as following:
145145

146146
**Parameters**:
147147

148-
{object} **user**: A plain object specifying the user information the information should be retrieved for. More information about the structure can be found [here](TODO).
148+
{object} **user**: A plain object specifying information about the user to retrieve data for. More about the user structure can be found [here](TODO).
149149

150150
{[string]} **dimensions**: An array containing the names of the dimensions to lookup.
151151

152-
{boolean|null} **sign**: A boolean value, specifying if the call should be sign, only available if the *secret* is configured. It is strongly advised, not to use a signed call when utilizing this library.
152+
{boolean|null} **sign**: A boolean value specifying if the call should be signed, which is only available if the *secret* is configured. It is strongly advised not to use a signed call when utilizing this library.
153153

154-
{function|null} **onLookUp**: A function, which is triggered after the result of the lookup was retrieved. The function has the retrieved information as first parameter.
154+
{function|null} **onLookUp**: A function which is triggered after the lookup result has been retrieved. The function has the retrieved information as the first parameter.
155155

156156
**Example Usage**:
157157
```javascript
@@ -522,4 +522,4 @@ The cookie part of the utilities contains functions to validate, match, or retri
522522
window.alert('Is the funny session over or did it never start?');
523523
}
524524
```
525-
<br/>
525+
<br/>

0 commit comments

Comments
 (0)