EnglishDit artikel helpt je om te testen met onze verschillende REST-API’s.
De documentatie van alle beschikbare endpoints kan je vinden op: https://developers.tweakwise.com/
Om te starten met het testen van de Front-end API heb je een endpoint en instancekey nodig.
Credentials:
Instancekey: ca555417
Domein: https://gateway.tweakwisenavigator.com
Lees hier meer over de verschillende domeinen en het gebruik van een instancekey.
Beschikbare categorieën:
|
Naam |
ID |
Parent-ID |
|
Root |
1000 |
|
|
Clothing |
1001 |
1000 |
|
Sweaters & Hoodies |
1004 |
1001 |
|
Shirts |
1005 |
1001 |
|
Accessories |
1002 |
1000 |
|
Office Supplies |
1003 |
1000 |
Zie ook onze demoshop voor meer informatie.
Suggestions
Lees in dit artikel meer over het gebruik van de Suggestions-API.
In de demo-omgeving is er een Autocomplete ingericht voor de categorie Root (ID: 1000). Dit resulteert bijvoorbeeld in de volgende 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
De volgende call heet navigation-search, met deze endpoint is het mogelijk om de zoekresultatenpagina te vullen.
Parameters:
- tn_q
Dit is de querystring parameter die de gewenste zoekterm bevat.
De response bestaat uit een paar onderdelen:
- Facets
Deze facetten hebben als doel dat de eindgebruiker de mogelijkheid heeft om te filteren op bijvoorbeeld merk of kleur. Er zijn 5 verschillende types, die een andere front-end implementatie nodig hebben: Tree (bij een categoriefilter), link, slider, checkbox en color.
- Items
Deze items komen overeen met de huidige geselecteerde facetten en uitgevoerde zoekopdracht. De producten zijn gesorteerd volgens de ingerichte sortering in Tweakwise.
- Properties
Dit object bevat informatie zoals het aantal pagina’s, aantal producten, ingerichte redirects, en de opties waarop gesorteerd kan worden.
Bekijk voor een volledig overzicht van de parameters en de opties in de response de API-documentatie.
Navigation:
Met de navigation endpoint is het mogelijk om een product lister pagina te vullen. Dit endpoint heeft dezelfde mogelijkheden als het navigation-search endpoint, echter wordt hier geen query string parameter meegestuurd.
Recommendations
Lees dit artikel voor meer over het gebruik van de Recommendations-API.
In de demo-omgeving zijn de volgende regels ingericht:
Featured recommendations ID: 1, 2
Up & Cross sell recommendations ID: 1, 2
Up & Cross sell recommendations groupkey: alternatives
Raadpleeg onze demoshop om een aantal voorbeeld product ID’s te zien.
| Voorbeeld requests |
| 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 |