Contentaanbevelingen die worden geleverd als ruwe JSON in plaats van als weergegeven widget, zodat je ze in je eigen lay-out kunt weergeven. Ideaal voor een zelf ontworpen carrousel, een single-page-app, een native app, of een blok “misschien vind je dit ook leuk” dat precies moet aansluiten op je eigen designsysteem.
In het panel: Nieuwe campagne › App / API › JSON-API — Contentaanbevelingen.
De stappen
Zes stappen: Catalogus, Interacties, Aanbeveling, Data in de respons, Code en Prestaties.
1. Catalogus
Je contentcatalogus — artikelen, handleidingen, video’s. Elk item heeft een interne ID, een titel en een URL nodig, plus een afbeelding als je lay-out die gebruikt. Categorieën en tags zijn de moeite waard om goed in te vullen: daarmee kunnen aanbevelingen een onderwerp volgen in plaats van alleen de algemene populariteit.
2. Interacties
De engine leert van wat mensen lezen, liken, becommentariëren en uitlezen. Omdat je de JSON zelf weergeeft, moet je deze interacties zelf doorgeven — Personyze kan geen gelezen artikel afleiden uit een lay-out die het niet zelf heeft getekend.
Dit overslaan is de gebruikelijke reden dat een contentaanbeveling via JSON iedereen dezelfde algemene lijst geeft: er is geen leesgeschiedenis om op te personaliseren.
3. Aanbeveling
Kies de context — homepage, artikelpagina, categoriepagina — en het algoritme. De beschikbare aanpassingen:
- Tijdvenster — vandaag, recent, de afgelopen dagen, de afgelopen week, of altijd.
- Categoriebereik — uit alle categorieën, of uit de categorie van het huidige artikel.
- Interessebereik — uit de afgeleide interesses van de bezoeker.
- Actualiteit en volgorde — nieuwste eerst, oudste eerst, recent toegevoegd, of nieuw sinds het laatste bezoek van de bezoeker.
- Samen voorkomen — samen bekeken binnen de huidige categorie.
Filters maken de pool nog kleiner — contenttype, tag, categorie, of elk eigen veld in je feed.
Zie Typen aanbevelingsalgoritmes voor de algoritmes in detail.
4. Data in de respons
Personyze genereert een JSON-array met objecten, elk met de velden die je kiest. Je definieert hier je eigen responscontract, dus kies precies wat je renderer nodig heeft.
Kies voor elk veld het bronveld uit je catalogus en geef het de sleutelnaam die je in de uitvoer wilt. Een typische selectie voor content:
[
{
"internal_id": "nw-a001",
"title": "How to layer for winter hiking",
"category": "Skills",
"image_1": "https://example.test/img/layering.jpg",
"url": "https://example.test/journal/how-to-layer-for-winter-hiking"
},
...
]
5. Code
De wizard maakt het snippet om in te sluiten. Er zijn twee manieren om het te gebruiken:
- Op een pagina — het snippet wijst de JSON-array toe aan een JavaScript-variabele die je zelf een naam geeft, en je eigen code geeft die weer.
- Aan de serverkant of vanuit een app — roep
/rest/tracker-v1aan en lees de JSON uit het velddatavan de passende actie. Zie Een eigen aanbevelingsapp bouwen.
6. Prestaties
Resultaten zodra het live is — begrensd door wat je terugmeldt, zoals hierboven.
Let op: er is geen QA-stap
JSON-API-campagnes hebben geen QA-stap, omdat er geen weergegeven content is om te bekijken. Controleer door de JSON op te halen en die zelf na te kijken: het juiste aantal items, de velden die je hebt gekozen aanwezig, en waarden die gevuld zijn in plaats van leeg.
Gerelateerd
- JSON-API — Productaanbevelingen
- Wizard contentaanbevelingen — de versie met een weergegeven widget.
- Het object articles in de REST API.