The Powerful and Comprehensive API for Mobile App Development and Testing

© Copyrights by Bitbar Technologies Ltd. 2015
All rights reserved. 1
20 January 2015
Ville-Veikko Helppi
Technical Product Manager
ville-veikko.helppi@bitbar.com
The Powerful and
Comprehensive API for Mobile
App Development and Testing
W E B I N A R

Agenda
• The Characteristics of Great API
• The Basics of Communication Mechanisms
• Three Categories for API Usage
– Authentication (security)
– Managing Projects
– Getting Results
• Hands-on Example (cURL)
• Additional resources
• Q&A

The Characteristics of Great
Application Programming
Interface

• The way to integrate (different) systems
• The way to expose/transport data easily,
automatically and instantly
• Modular, scalable and versatile API calls
• Great standards
– REST(ful) / JSON / OAuth etc.
• Security
– No manual hassling – all communications
through API
Why API?

• Easy to learn, easy to use, hard to misuse
• Easy to read, maintain, extend
• Appropriate for every user
– Some people can configure/create access,
some only need to use
• Provides all features than can be done
also manually
• Versatile API backs up test automation
approach and complements Agile process
Characteristics of Great API

APIs Are Not Only for Services!

The Manual Flow
Application
Results
Logs, outputs, data
Screenshots

Access Devices via API
Development environments and tools Real Mobile Devices (hundreds of)
Data;
Results, Screenshots & Logs
Automatic, instant
upload on devices

The Basics of
Communication Mechanisms

For example:
GET /oauth/token?client_id=testdroid-cloud-
api&grant_type=password&username=example@bitbar.co
m&password=P4s$w0rd&parameters=more
The Basics

GET: fetch an existing resource. The URL contains all the
necessary information the server needs to locate and
return the resource.
POST: create a new resource. POST requests usually carry
a payload that specifies the data for the new resource.
PUT: update an existing resource. The payload may
contain the updated data for the resource.
DELETE: delete an existing resource.
The Basics - Verbs

Requests and Responses

2xx: Successful
202 Accepted: the request was accepted but may not include the
resource in the response.
204 No Content: there is no message body in the response.
205 Reset Content: indicates to the client to reset its document view.
206 Partial Content: indicates that the response only contains partial
content.
3xx: Redirection
301 Moved Permanently: the resource is now located at a new URL.
303 See Other: the resource is temporarily located at a new URL. The
Location response header contains the temporary URL.
304 Not Modified: the server has determined that the resource has not
changed and the client should use its cached copy.
The Basics – Error Codes

4xx: Client Error
400 Bad Request: the request was malformed.
401 Unauthorized: request requires authentication. The client can repeat
the request with the Authorization header.
403 Forbidden: server has denied access to the resource.
405 Method Not Allowed: invalid HTTP verb used in the request line, or
the server does not support that verb.
409 Conflict: the server could not complete the request because the client
is trying to modify a resource that is newer than the client's timestamp.
5xx: Server Error
501 Not Implemented: the server does not yet support the requested
functionality.
503 Service Unavailable: this could happen if an internal system on the
server has failed or the server is overloaded.
The Basics – Error Codes

Access via Comprehensive API

• Authentication
• Project Management
– Create, Delete, Configure, Managing Users
• Configuring Access and Assets
– Configs, Upload/Download Files (App & Tests)
– Device Access & Device Group Configuration
• Running Tests
– Upload App + Tests <-> Download Results/Data
– Notifications, Sharing, Pre-processing of Data
Access via Comprehensive API

Authentication

SEND Header=Accept: application/json
client_id=testdroid_cloud_api
grant_type=password
username=email@address.com
password=XXXXXXXX
CURL:
curl -X POST -H "Accept: application/json" -d "client_id=testdroid-cloud-
api&grant_type=password&username=email@address.com&
password=XXXXXXXX" https://cloud.testdroid.com/oauth/token
Authentication

Projects and Managing Those
via API

Get List of Projects

Authorization: Bearer <ACCESS_TOKEN>
CURL:
curl -H “Accept: application/json” -H “Authorization: Bearer <ACCESS-
TOKEN>” https://cloud.testdroid.com/api/v2/me/projects
or
curl –H "Accept: application/json"
"https://cloud.testdroid.com/api/v2/me/projects?access_token=<ACCES
S-TOKEN>"

Create a Project

Authorization: Bearer <ACCESS_TOKEN>
name=name of new project
CURL:
curl -X POST -d "name=NewProject" -H "Authorization: Bearer
fac84a04-feb0-42ed-a810-6d859e43c123"
https://cloud.testdroid.com/api/v2/me/projects
or
curl -X POST -d "name=NewProject2”
“https://cloud.testdroid.com/api/v2/me/projects?access_token=<ACCES
S-TOKEN>"
Create a Project

Update a Project

CURL:
curl -X POST -d "projectId=75013784&name=NewName&description=
Something&common=false" -H "Authorization: Bearer 5f5c3ad0-1f70-4435-
ae4f-ec2a9d20a985"
https://cloud.testdroid.com/api/v2/me/projects/75013784
or
curl -X POST -d "projectId=75013784&name=NewName&description=
Something&common=false"
"https://cloud.testdroid.com/api/v2/me/projects/75013784?access_token=38
f57e00-a2f7-40d0-bdc2-e041b95ff43e"
Update a Project

Upload an App

CURL:
curl -F file=@"filename.apk"
"https://cloud.testdroid.com/api/v2/me/projects/<PROJECTNUMBER>/fi
les/application?access_token=<ACCESS-TOKEN>"
Upload an App

Start a New Test Run

CURL:
curl -X POST -d “projectId=<PROJECTID>&name=<NAME OF NEW
TEST RUN>”
“https://cloud.testdroid.com/api/v2/me/projects/<PROJECTID>/runs?ac
cess_token=<ACCESS-TOKEN>"
Upload an App

Upload w/Python

Get Results from Testdroid
Cloud via API

Get Details of Test Run

CURL:
curl -H "Accept: application/json"
https://cloud.testdroid.com/api/v2/me/projects/<PROJECTID>/runs/<TE
STRUNID>/device-runs?access_token=<ACCESS-TOKEN>

Get Device Run Logs

CURL:
STRUNID>/device-runs/<DEVICEID>/logs?access_token=<ACCESS-
TOKEN> > log.txt
Get Device Run Logs

Get Device Run Performance

CURL:
STRUNID>/device-
runs/<DEVICEID>/performance?access_token=<ACCESS-TOKEN> >
log.txt

Get Screenshots

CURL:
(List of screenshots)
STRUNID>/device-
runs/<DEVICEID>/screenshots?access_token=<ACCESS-TOKEN>
(Specific Screenshot)
STRUNID>/device-
runs/<DEVICEID>/screenshots/<SCREENSHOTID>?access_token=<A
CCESS-TOKEN>
Get Screenshots

Hands-on - Let's cURL!

• Testdroid API for Python
– https://github.com/bitbar/testdroid-api-client-python
• Testdroid API for Ruby
– https://github.com/bitbar/testdroid-api-client-ruby
• Testdroid API for Java
– https://github.com/bitbar/testdroid-
api/tree/master/src/main/java/com/testdroid/api/sample
• Testdroid API description
– http://docs.testdroid.com/_pages/client.html
Additional Examples

Video recording & slides of this webinar will
be soon available at Vimeo and Slideshare!
Please visit at www.testdroid.com for more
information.
THANK YOU!
W E B I N A R

We operate the largest global device
cloud with over 400 devices
instantly available for developers
Devices from the US, Europe, China, Japan and Korea
– global devices for global customers

The Powerful and Comprehensive API for Mobile App Development and Testing

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Similar to The Powerful and Comprehensive API for Mobile App Development and Testing

Similar to The Powerful and Comprehensive API for Mobile App Development and Testing (20)

More from Bitbar

More from Bitbar (12)

Recently uploaded

Recently uploaded (20)

The Powerful and Comprehensive API for Mobile App Development and Testing