Manager API

What is the API for?

The ubudu contextual interactions API (Application Programming Interface) provides access to all key cloud based resources that are used to pilot ubudu contextual interactions mobile SDKs.

Using the API, fully described and testable at http://docs.ubudu.apiary.io/, to take advantage of:

  • Integrate the dynamic creation and update interactions triggered by beacons and geofences with your own CRM/back-office

  • Import statistics on your geofences, and triggers on your own analytics

  • Create new applications e.g. give your venues manager the possibility to update some campaigns

  • Consolidate or hook your user logged activity to specific interactions (coming soon)

Two sorts of API web services

There are two sorts of API web-services :

  • Private Admin API methods (read & write) : It is used to pilot/ access the ubudu contextual interactions platform from an application. Authentication required is a valid OAUTH access token with write privilege.

  • Query API methods (read only) : It is used by the mobile SDK clients to query and synchronize their local database of interaction rules with the latest interactions defined in the back-office. Authentication required is either an OAUTH access token with public/read privilege or the UUID of application namespace.

Ressources available

There are 5 types of resources that you might need to manipulate:
Asset resources

  • UVenue: a real world location such as a shop, a museum, a café etc.

  • UBeaconDevice: an iBeacon compatible device hardware with a specific advertsing.

Contextual interactions rules resources

  • UApplication: a separate context with its own mobile users, interactions rules and logging environment. An application can have many geofences and beacons interaction rules.

  • UGeofence: a virtual perimeter for a real-world geographic area characterized by a radial area around a specific latitude, longitude. A geofence can have several rules, actions associated and specific user targeting and limits parameters.

  • UBeacon: A resource that wraps the contextual interaction rules when discovering a BLE iBeacon compatible signal. A uBeacon resource can have several rules, actions associated and specific user targeting and limits parameters.

Simplified Data model