Using Appdome-DEV API for Postman Collection

Prior to integrating the Appdome-DEV REST API to your CI/CD workflow, you may want to test and customize the different available request. To make this easier, we have created a Postman collection of the available requests.  We recommend you download this json file:  Appdome-DEV API for Postman Collection.

Postman is an API client tool which helps with testing. It lets you configure requests and send them with various controls and environment set-ups.

This knowledge base will introduce our collection and some basic functions of Postman. For more about using postman, see Postman Learning Center.

Before using the Appdome Postman collection, please read about Appdome-DEV REST API

How to Use Appdome Postman Collection

Prerequisites for Using Appdome-DEV™ Build-to-Publish API

1. Install  Postman on your workstation.
2. Download Appdome-DEV API for Postman Collection.
3. Gather Appdome user API token or app team API key
   1. Login to Appdome
   2. Click your name on the top right-hand corner –> My Profile
   3. Copy your API Token
4. Gather Fusion Set API Key
   

Importing the Collection to Postman

1. Launch Postman and click Import.
2. Choose the downloaded collection file.
3. Within your added collection, click the Manage Environments button. First, Get your API Token, Team’s API Key (if needed) and Fusion Set API key.
4. Enter Server Name, Authorization, and team_id.
   – To make testing easy, we recommend setting up environments to hold your Authorization token and if building on App Teams your Appdome account’s Team API Keys (if you have multiple Appdome accounts or teams, you can set up multiple environments.)
5. Select your environment from the drop-down.

Setting Up an Environment for Single Tasks

Variables defined in the environment set up will replace parameters such as {{Authorization}}on run time:

The collection is added to your library:

• Expand the Appdome DEV API Collection to see all task requests.
• Select the LifeCycle iOS/Android Post Request.
• A folder with a series of Tasks for individual steps with your Appdome user account.
• A folder for Teams requests (logs and information) can be added and found here for app teams.

Configuring Requests

Before sending a request, you need to configure its parameters, body content, and variables.

First, select the request on the Library.

On the Params tab, you can add URL encoded parameters. Team_id is configured is this way.

1. If you want to send the request to a Team, check the team_id key (to send it in the request, and make sure team_id is configured in the environment or defined in the value column.)
2. Notice that ?team_id={{team_id}}is added to the request URL.

• If you want to send the request to the Appdome account API Token owner, uncheck the team_id key.

On the Body tab, you can configure the body of the request. Depending on the request, you can:

1. Enter required or optional form data values (such as app_id, provisioning profile)
2. Upload files (app, provisioning profile)
3. Edit the overrides JSON content

• Make sure to use the checkboxes to turn on/off the desired keys.
• Note the Description field for more information. Some fields may be mandatory for iOS but invalid for Android etc.

On the Pre-request Script Tab, you can configure variables that need to be inserted into the URL. This is currently only relevant for the GET requests: Task-Download and Task-Status.

These requests need to pass the task_id in the URL. In the Pre-request Script tab, insert the task is as the value: pm.environment.set("task_id", "<task_id>");

Sending Requests

Once the request is configured, click Send. The response will appear below.

For requests whose response is a file – LifeCycle and Task-Download, click the arrow and select Send and Download.

How Do I Learn More

Check out Appdome Platform, Appdome-DEV, or request a demo at any time.

If you have any questions, please send them our way at support@appdome.com or via the chat window on the Appdome platform.

Thank you!

Thanks for visiting Appdome! Our mission is to make mobile integration easy. We hope we’re living up to the mission with your project. If you don’t already have an account, you can sign up for free.