Articles on: For Developers

Getting Started:

Getting Started:

You can fork this repository and use it in your Android IDE, for example Android Studio:

This is an open-source project to display how you can create your own custom AppUI application within a few minutes. I have already created an AppUI click to see Sample AppUi on your browser.

You can also download and install the demo application.

Clone this repository and import it into Android Studio

git clone

First of all, we need X-API-KEY.

You can find your X-API-KEY on your CDP Dashboard and create a Connection to get your API_KEY.

Now you just need one more key: The appUI address code. Copy the code at the end of the URL. For instance in this URL the appUI address code is YD7L3lG1LVFELz1.

Copy these two keys and paste them in the api.propertise.txt file inside your android project:

Now Define build configuration fields in the Gradle file. These constants will be accessible at runtime as static fields of the BuildConfig class:

Your Application is almost ready, you just need some customization like colors, app name, etc: Find the res/value folder under the common module and open the color file to change app primary color that uses appui_color:

in that folder, we have also another file named strings, you can find app-name and change the name of your application.

The last item you need to change to have your own application is the package name and application id, follow the images to rename the ids:

We are done, our appUI is ready

Run the project and test the application.

If you want to play with AppUI API and have a more desired application you can find endpoints inside BoardsService under the data/remote module.

You can also use the postman collection that shows endpoints responses data. Just copy this link and import the APPUI collection to your workspace:

Updated on: 22/01/2023

Was this article helpful?

Share your feedback


Thank you!