-
Notifications
You must be signed in to change notification settings - Fork 0
Getting Started
So you have successfully registered your tapp in the developer administration?
You may have noticed the 'permissions' accordion while configuring the tapp.
These permissions are fundamental to the chayns Backend API, since they are required in every request to the API (the required permissions for each request are listed in the specific reference. In the tapp administration just select all the permissions you need).
The current available permissions are
- PublicInfo
- UserInfo
- SeeUAC
- EditUAC
- DeviceInfo
- Push
- Intercom
The requests in frontend and backend have the same structure. For the authorization you can use the Tapp Secret along with the TappID in the backend or a PageAccessToken in the frontend. (Take a look at Authorization )
The request structure looks like
https://api.chayns.net/{APIVersion}/{LocationID}/{Controller}/{ObjectID}
- the ApiVersion is a compound of the letter 'v' and the API version. I.e. it could look like 'v2.0'
- the ObjectID parameter is optional (see reference)
In addition it is possible to filter your GET requests with fields and filters. Take a look at this page for more information on parameters, fields and filters.
The current API version is v2.0 .
To use the chayns Backend API, you have to be registered in the Tobit.Software Partner Network (TSPN).
To register, please visit tobit.software/Partner.