You can use the API to interact with data from Gluu. The use cases could be PowerBI, Data analytics or Integrations with RPA tools.
API Token
The API token is a full access token and can be found under Account Settings > Apps & Integration > "API Integration". Click "Settings" to generate the needed authorization token. You need to be account owner or admin to view and create tokens.
The API is exposed as OAS (Open Api Specification) and can be seen here:
Current version: api.gluu.biz/api-browser
Upcomming (improved) version: api.gluu.biz/api-browser-next
You can use the read-only tokens for read operations and you need to create a impersonated token for write operations, any changes will be logged as actions done by the user of that token.
Schema
All API access is over HTTPS, and accessed from https://api.gluu.biz. All data is sent and received as JSON.
All timestamps return in UTC time, ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
Every entity has a class and id like so:
{
"_class": "component",
"_id": "custcomp-3067881d-72fd-41f4-8123-2ef1ec827f9c",
"prop1": "..."
}
You can reduce the response payload by adding a filter for specific classes you are interested in.
Class Types
Data queries (starting with /data) returns an array of items matching the api query. This call can return different types where every object is defined by a "_type". You can expect any of the following:
category
group
process
activity
form
formversion
formdata
task
caseworkflow
user
suggestion
Hierarchy of class types
This is the data structure of what types are created parent to other.
