This page defines the primary concepts of Mobapi, be sure to check it out before going further in the documentation
Besides its very abstracted meaning, an API can be seen as a group of endpoints dedicated to a system or a software (a mobile app for instance). Each call to an endpoint composing an API is counted as one API call.
An endpoint is an entry point to a service, querying one will trigger an action from the associated service depending on the query parameters.
Each Mobapi endpoints are linked to a pre-defined datasource, the first action triggered on the platform when querying a customer endpoint is to retrieve data from this datasource. The retrieved data is then processed and exposed.
From DBMS to Web services, there are numerous ways to store and retrieve data nowadays. We call a provider any web service or DBMS able to be turned into a data source in whatever exploitable format. Each provider has its own parameters set used to generate and configure datasources.
For instance, a database provider as MySQL takes multiple parameters (host, db user, etc.) to create a datasource while the Google Sheet only requires an authenticated google account. There is no limit to the number of datasources a provider can generate.
A datasource is basically just like an endpoint, it's an entry point to the provider service used to retrieve data. Each datasource is configured with its own provider's parameters values in order to query specific data. The difference between a datasource and an endpoint lays in their purpose :
- A datasource delivers raw data from its provider. Meaning that the provider determines the data format and the access policy.
- An endpoint uses a datasource to obtain raw data and process it by applying transformations, filtering and formatting actions. It then delivers the processed data to its clients.