Met de Tweakwise front-end REST API is het mogelijk om een koppeling met je website te maken voor de merchandising en facetfiltering van je al je lijstpagina’s. Om je lijstpagina te vullen gebruik je het navigation endpoint. De response bestaat uit een paar onderdelen:
- Een lijst met facetten
Deze facetten hebben als doel dat de eindgebruiker de mogelijkheid heeft om te filteren op bijvoorbeeld categorie, merk of kleur. Er zijn 5 verschillende types, die elk een andere front-end implementatie nodig hebben: Tree (bij een categoriefilter), link, slider, checkbox en color. - Een lijst met producten
Daarnaast bevat het resultaat een lijst met producten. Deze producten komen overeen met de huidige filters. Deze producten zijn gesorteerd op basis van de Merchandising module in de Tweakwise App. - Een object met eigenschappen over het request (properties)
Dit object bevat informatie zoals het aantal pagina’s, aantal producten en de opties waarop gesorteerd kan worden.
Bekijk voor een volledig overzicht van de parameters en de opties in de response de API-documentatie: https://developers.tweakwise.com/api/#/Navigation
Testen
Om te starten met het testen van de Front-end API heb je een domein en instancekey nodig.
Credentials:
Instancekey: ca555417
Domein: https://gateway.tweakwisenavigator.com
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.
Voorbeeld requests |
Hosts
Het endpoint voor de frontend API is beschikbaar op twee verschillende domeinen. Voor het gebruik van deze domeinen zie: https://support.tweakwise.com/nl/cat/rest-api/1284