This Knowledge Base article provides a brief introduction to the Appdome REST API, which enables high productivity mobile organizations to fully automate the building process at Appdome and incorporate Appdome as part of their automated deployment toolsets and continuous integration and continuous delivery (CI/CD) workflows.
We hope you find this knowledge base useful and enjoy using Appdome!
The Appdome REST API enables an enterprise or DevOps group to integrate Appdome directly into any continuous development or mobile deployment environment, including automated build scripts.
For instance, you might be using a tool like Jenkins to automatically deploy a new build environment every night at 4 am. The Appdome REST API could be used to Fuse a pre-defined set of Fusion Sets as part of that automated build process, resulting in full automation of your entire workflow.
In order to use Appdome’s REST API, you’ll need:
Once you have access to Appdome’s API service, you can get (or reset) your API authentication token from your profile page:
|API Description||Generates a new API Token|
If you want to send API command to a team (in order to use the team’s Fusion Sets and settings), you will have to use the Team’s ID (note: The team’s class must also be DEV).
Most API requests use a pre-defined fusion set to configure the task’s settings. Once you have configured a Fusion Set with the features you want to add to your apps you can use the fusion set’s API key to refer to it when sending requests.
Note about Playground Fusion Sets: Each app in on the platform has access to all fusion sets of the same platform. In addition, each app has its own “playground” fusion set, that is not accessible to other apps. This is the default setting and is meant for you to “play” and test different configurations. It cannot be used by the Appdome’s REST API, and it does not have an API key. Therefore, before configuring a fusion set to use with Appdome’s API, make sure to create at least one shared Fusion Set (by clicking the “copy” button on any app’s playground set).
To use a Fusion Set with an API request, it must have gone through the Build, Add Context and Sign at least once on the platform (with GUI)
You can start by uploading an app with the Single Tasks REST API.
You can also use our API requests Postman Collection.
If you have any questions, please send them our way at email@example.com or via the chat window on the Appdome platform.