For continued mobile development project Bitbar Testing can be integrated to your continuous integration environment and tests run through API rather than manually uploading and configuring test projects.
Bitbar Testing provides a very powerful and useful API for its users to manage all aspects of mobile development and test automation. The API allows access to our device farm, manage projects, test runs and results, plus many other things over a RESTful architecture returning JSON structures with appropriate HTTP response codes.
A good starting point on using REST communication can be found here.
By default all api call responses are in JSON format. This was not always the
case so many of the used samples still include the header
Available API Clients¶
Swagger is installed for all on-premise and private customers where also administrator privileges are available. Swagger is a tool for browsing and testing REST API in real-time in a browser.
Open Swagger at
https://<your cloud>/cloud/swagger-ui.html in your Bitbar on-premise or private cloud setup.
Getting Started Examples¶
By default all of the api calls respond in XML format. To switch to
JSON_ format, include header
Accept: application/json to the
Note that all request timeouts are in seconds.
Create a Bitbar Testing Project¶
To create a new project from the command line using cURL and apiKey:
curl -H "Accept: application/json" -u xYY5hsdPXAXsBBd1G3ijnb18wlqPeOA6: -X POST -d "name=NewProject" https://cloud.bitbar.com/api/me/projects
Returns project listing containing details, Test Runs and Device Runs (accept application JSON).
curl -H "Accept: application/json" -u xYY5hsdPXAXsBBd1G3ijnb18wlqPeOA6: -X GET https://cloud.bitbar.com/api/me/projects
Details of a Specific Project¶
Query the details of a specific project defined by the project’s id PROJECT_ID and authenticating using apiKey:
curl -H "Accept: application/json" -u xYY5hsdPXAXsBBd1G3ijnb18wlqPeOA6: -X GET https://cloud.bitbar.com/api/me/projects/PROJET_ID
Get Test Run Details¶
Get a test run’s details by authenticating using the apiKey:
curl -H "Accept: application/json" -u xYY5hsdPXAXsBBd1G3ijnb18wlqPeOA6: -X GET https://cloud.bitbar.com/api/me/projects/PROJECT_ID/runs
Get Details of Certain Device Run¶
Authenticating using the API key:
curl -H "Accept: application/json" -u xYY5hsdPXAXsBBd1G3ijnb18wlqPeOA6: -X GET https://cloud.bitbar.com/api/me/projects/PROJECT_ID/runs/RUN_ID/device-runs