Wat is een API-koppeling?
Een API-koppeling is een technische connectie tussen twee systemen. Hiermee is het mogelijk om automatisch data uit te wisselen tussen beide platformen. API-koppelingen zijn vaak technisch lastige materie. Mocht je hiermee aan de slag willen dan is het verstandig om de hulp van Insiders in te schakelen.
Hoe maak je een API-kanaal?
In plaece.base is de mogelijkheid aanwezig om een API-kanaal in te richten. Het inrichten hiervan is alleen mogelijk door medewerkers van Insiders, dit kun je helaas niet zelf.
Middels een API-kanaal wordt het mogelijk om data uit te wisselen met een extern systeem. Er zijn hierin twee verschillende smaken beschikbaar:
Export
Een exportkanaal zorgt ervoor dat er informatie wordt verzonden. Dit betekent dat content welke aanwezig is in plaece.base aangeboden kan worden richting een extern systeem. Het externe systeem kan de informatie uitlezen, verwerken en tonen.
Stel dat een partner een externe website heeft laten realiseren maar wel graag gebruik wil maken van alle evenementen, dan kan deze informatie beschikbaar gesteld worden door daarvoor een specifiek API-kanaal in te richten.
Import
Een importkanaal zorgt ervoor dat externe informatie wordt ingelezen in plaece.base. Hiermee kan content vanuit een externe bron worden geïmporteerd in plaece.base. Een voorbeeld is bijvoorbeeld het automatisch inlezen van alle theatervoorstellingen van het theater in de binnenstad.
Voor beide kanalen geldt dat deze geconfigureerd kunnen worden aan de hand van specifieke filters. Deze filters zorgen ervoor dat de content anders wordt verwerkt. Zo is het mogelijk om in het exportkanaal de data te beperken, zodat een partner alleen de informatie ontvangt welke zij nodig hebben. Voor het importkanaal geldt dat bepaald kan worden hoe de informatie wordt opgeslagen in plaece.base.
Hoe krijg ik toegang?
Alle data is standaard beveiligd, wat betekent dat je specifiek toegang moet krijgen om een API-kanaal te kunnen gebruiken. Dit werkt op basis van een API-token, wat je kunt vertalen naar een "sleutel". Deze sleutel heb je nodig om alle data te kunnen uitlezen. Per partner wordt door Insiders altijd een unieke sleutel aangemaakt en aangeleverd.
Belangrijk: zorg ervoor dat met deze informatie vertrouwelijk wordt omgegaan. Zo zorg je ervoor dat de data altijd bij de juiste partners terechtkomt.