Home

Welcome to the chayns backend wiki. We give you a insight on how to work with the chayns® Backend API. It contains an introduction to the backend api, all the version changes and a complete reference for all functions.

The chayns Backend API is an extension to the chayns Frontend API and provides more functionality. It allows you to send intercom messages and push notifications to your customers and to manage the user information with the UAC roles and much more. You can also validate and authorize the user accesstoken.

First you need to sign up a Tobit.Software partner account. As a Tobit.Software partner you have a direct connection to the company. Whenever you need support we are there for you. Via the exclusive partner store you are able to receive official products as well as special releases, useful tools and exclusive offerings. Furthermore we provide you with the latest information and know how and recommend you to interested customers as a Tobit Authorized Partner.

To use the chayns® Backend API, you have to register your Tapp in the Partner Network Tapp administration. After you registered your tapp in the administration, you will receive a tapp secret and an installation code. The secret will be used for authorization later on. This secret is very important and you shouldn't use your secret in your frontend!

Using the installation code instead of a file path, you can immediately install the tapp on any chayns site ( Site Management -> Tapps -> Add Tapp -> External Tapp ).

Table of Contents

1. Home
2. Getting Started
3. Authorization
4. Parameters, Fields & Filters
5. Reference
6. AccessToken
7. Location
8. Intercom
9. Email
10. User
11. Push
12. Device
13. Group
14. Group Member