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.
Postman is an API client tool which helps with Testing. It lets you configure request 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 collection, please read about Appdome-DEV REST API
How to use App done-DEV API Postman Collection
Importing the Collection
- Install Postman on your workstation.
- Download the Appdome API requests collection.
- Launch Postman and click Import.
- Select the collection file.
The collection is added to your library:
- LifeCycle Request
- A folder with a series of Tasks for individual steps.
- A folder for Teams requests (logs and information)
Setting Up an Environment
To make testing easy, we recommend setting up environments to hold your Authorization token and (if needed) Team API Keys (if you have multiple users or teams, you can set up multiple environments.
- Click the Cog icon next to the environments drop-down.
- Click Add.
- Enter Variables:
- Variable: “Authorization”, Initial Value: Your API token
- Variable: “team_id”, Initial Value: Your Team API key
- Click Add
- Select your environment from the drop-down.
Variables defined in the environment set up will replace parameters such as {{Authorization}}on run time:
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.
- 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.
- Notice that
?team_id={{team_id}}is added to the request URL.
- If you want to send the request in a personal account, uncheck the team_id key.
On the Body tab, you can configure the body of the request. Depending on the request, you can:
- Enter required or optional form data values (such as app_id, provisioning profile)
- Upload files (app, provisioning profile)
- Edit the
overridesJSON content
- Make sure the 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.
Nitzan Posener