API Beeyond

Momenteel zijn er beperkte API mogelijkheden (API versie 1.1) beschikbaar m.b.t. Beeyond. O.a. de volgende API koppelingen zijn getest en beschikbaar vanaf versie 1.8.3.8.x.

  • Read API: De Read API kan gebruikt worden om één record op te halen. Daarbij is het mogelijk om bv, wel alle relaties gekoppeld aan dat ene record ook op te halen.

  • Search API: De Search API is vergelijkbaar met de Read API. Het verschil is dat bij de Read API een specifiek record wordt opgevraagd, en bij de Search API kan een lijst van records worden opgevraagd.

  • Create API: Deze API kan gebruikt worden voor het aanmaken van nieuwe records. Met deze call kunnen geen bestaande records worden aangepast in de hoofdentiteit, wel records in gerelateerde tabellen kunnen hiermee automatisch worden aangemaakt. De API is niet bedoeld om in bulk grote hoeveelheden data toe te voegen.

  • Update API: De update API kan gebruikt worden voor het wijzigen van gegevens. Via dit statement kunnen ook relaties gelegd worden naar bestaande records. Let wel op dat het niet mogelijk is om via deze update direct nieuwe relaties aan te maken.

 

Dit document is de basis waarin aangegeven wordt wat er momenteel mogelijk (en niet mogelijk) is met de Beeyond API, en welke functies er nog ontwikkeld gaan worden.