NederlandsThis article helps you test our various REST APIs.
You can find the documentation of all available endpoints at: https://developers.tweakwise.com/
To start testing the Front-end API, you will need an endpoint and an instance key.
Credentials:
Instancekey: ca555417
Domain: https://gateway.tweakwisenavigator.com
Read more about the various domains and the use of an instance key.
Available categories:
|
Name |
ID |
Parent-ID |
|
Root |
1000 |
|
|
Clothing |
1001 |
1000 |
|
Sweaters & Hoodies |
1004 |
1001 |
|
Shirts |
1005 |
1001 |
|
Accessories |
1002 |
1000 |
|
Office Supplies |
1003 |
1000 |
Also, check our demo shop for more information.
Suggestions
Read more about the use of the Suggestions API.
In the demo environment, an Autocomplete was set up for the category Root (ID: 1000). This results in, for example, the following requests:
| Suggestions |
| https://gateway.tweakwisenavigator.com/suggestions/ca555417?tn_q=bla&tn_cid=1000 |
| https://gateway.tweakwisenavigator.com/suggestions/ca555417?tn_q=swea&tn_cid=1000 |
| Product suggestions |
| https://gateway.tweakwisenavigator.com/suggestions/products/ca555417?tn_q=bla&tn_cid=1000 |
Search
The next call is navigation-search. This endpoint lets you fill the search results page.
Parameters:
- tn_q
This is the query string parameter that contains the desired search term.
The response consists of various parts:
- Facets
These facets aim to allow the end-user to filter on, for example, brand or color. There are 5 different types, that all need a different front-end implementation: Tree (for a category filter), link, slider, checkbox, and color.
- Items
These items correspond with the currently selected facets and the executed search query. The products were sorted using the sorting that was set up in Tweakwise.
- Properties
This object contains information such as the number of pages and products, redirects and the options that can be used for sorting.
View the API documentation for a complete overview of the parameters and options in the response.
Navigation:
The navigation endpoint lets you fill a product lister page. This endpoint has the same possibilities as the navigation-search endpoint, but this endpoint doesn't send a query string parameter.
Recommendations
Read this article for more information on the use of the Recommendations API.
The demo environment has the following rules:
Featured recommendations ID: 1, 2
Up & Cross-sell recommendations ID: 1, 2
Up & Cross-sell recommendations group key: alternatives
See our demo shop to see a few example product IDs.
| Request examples |
| Featured |
| http://gateway.tweakwisenavigator.net/recommendations/featured/ca555417/2 |
| Up- & cross-sell product |
| http://gateway.tweakwisenavigator.com/recommendations/product/ca555417/121 |
| Up- & cross-sell recommendation rule |
| https://gateway.tweakwisenavigator.com/recommendations/product/ca555417/1/121 |
| Up- & cross-sell grouped |
| https://gateway.tweakwisenavigator.com/recommendations/grouped/ca555417/121/alternatives |