Die API

System Architektur

In Hublify gibt es zwei Arten von aufrufbaren API Endpunkten.

Einmal die datensatz-orientierte "Dataset API" zum Lesen und Schreiben von aller möglichen Daten(sets) und die "Functions API" zum  darüber hinausgehenden Auslösen von Hublify Funktionen.

Beide APIs sind in Ihrer Grundstruktur gleich und können über den jeweils gleichen Client mit gleicher Autorisierung angesprochen werden.

Schematic API Hublify With Datasets

 

1. Dataset API

Hublify erlaubt den Zugriff auf fast alle Daten über die generische „Dataset API“.

Ein Dataset entspricht im Prinzip jeweils einer eigenen Datenbank-Tabelle (oder eher einer VIEW) in Hublify. Ein Dataset kann aber auch noch von woanders her seine Daten bekommen. Doch dazu später mehr!

Zum Beispiel sind in Hublify Produkte, Aufträge und Kunden jeweils ein eigenes Dataset.

Über die API kannst du Datensätze in Datasets einfach auslesen, filtern und sogar BI-wise auswerten lassen. Es lassen sich auch mehrere Datenabfragen miteinander in einem api-request kombinieren, ähnlich einem SQL JOIN bzw. sub-selects.
Und natürlich kannst du über die API auch Datensätze anlegen bzw. updaten.


Um die Datasets per API anzusprechen brauchst du nur einige wenige API Endpoints:

  • data_getList – Returns an array of records.
    This can be like simple select-query or a fancy BI-reporting-query! 
     
  • data_get – returns one single record
     
  • dataset_getModel – returns the fields (attributes) defined for that dataset
     
  • data_create - creates a new data-record within that dataset. (The availability of this function for the specific dataset, depends on your access-rights and the dataset (and -source) itself.)
     
  • data_update - updates one or many existing data-records within that dataset. (The availability of this function for the specific dataset, depends on your access-rights and the dataset (and -source) itself.)
     
  • data_delete - deletes one or many data-records within that dataset. (The availability of this function for the specific dataset, depends on your access-rights and the dataset (and -source) itself.)

 

2. Function API

Über die Function API, die im Grundprinzip der "Dataset API" gleich ist, lassen sich über viele dezidierte Endpunkte noch viel mehr Hublify Funktionen aufrufen und auslösen.

Währende die Dataset API eher für das direkte "Read & Write" und Analysieren von Daten gedacht ist, ist die Funtion API von der Struktur her aufgebaut, wie klassische Remote-Procedure-Calls (RPCs).